Cara Mengakses dan Menggunakan Brex API

Developer sering mencari cara efisien untuk mengintegrasikan layanan keuangan ke dalam aplikasi mereka, dan Brex API menonjol sebagai solusi tangguh untuk mengelola batas pengeluaran, transaksi, dan sumber daya tim. Artikel ini memandu Anda melalui proses mengakses dan menggunakan Brex API. Anda akan belajar cara menyiapkan otentikasi, menjelajahi titik akhir (endpoint), dan mengintegrasikan API ke dalam sistem Anda.

💡

Selain itu, untuk meningkatkan pengalaman pengujian Anda dengan Brex API, pertimbangkan untuk mengunduh Apidog secara gratis—platform lengkap yang menyederhanakan debugging, mocking, dan dokumentasi API, sehingga lebih mudah untuk memvalidasi panggilan Brex API tanpa pengaturan yang rumit.

tombol

Saat Anda melanjutkan, ingatlah bahwa penyesuaian kecil dalam pendekatan Anda, seperti memilih cakupan yang tepat selama pembuatan token, dapat secara signifikan memengaruhi keberhasilan integrasi. Oleh karena itu, perhatikan setiap langkah untuk memastikan konektivitas yang mulus.

Apa Itu Brex API?

Brex API menyediakan antarmuka RESTful yang memungkinkan developer untuk mengotomatisasi dan menyesuaikan alur kerja keuangan dalam platform Brex. Brex, sebuah perusahaan teknologi keuangan, menawarkan layanan seperti kartu korporat, manajemen pengeluaran, dan pelacakan biaya. Oleh karena itu, Brex API memungkinkan Anda untuk berinteraksi dengan fitur-fitur ini secara terprogram.

Brex API mencakup beberapa API khusus, seperti Team API untuk mengelola pengguna dan kartu, Transactions API untuk mengambil transaksi yang telah diselesaikan, dan Onboarding API untuk menangani rujukan. Masing-masing API ini melayani berbagai aspek manajemen keuangan, memungkinkan Anda untuk membangun laporan kustom, mengotomatisasi undangan pengguna, atau melacak pengeluaran secara real-time.

Selain itu, Brex menekankan keamanan dan kepatuhan, memastikan bahwa interaksi API selaras dengan standar industri. Oleh karena itu, ketika Anda menggunakan Brex API, Anda mendapatkan akses ke alat yang mendukung operasi keuangan yang skalabel tanpa mengorbankan integritas data.

Mengapa Anda Harus Menggunakan Brex API?

Anda harus menggunakan Brex API jika aplikasi Anda memerlukan integrasi dengan alat keuangan korporat. Misalnya, tim keuangan sering perlu menyinkronkan data transaksi dengan perangkat lunak akuntansi, dan Brex API memfasilitasi ini dengan menyediakan titik akhir untuk membuat daftar transaksi dan akun.

Terlebih lagi, API mengurangi upaya manual dalam mengelola batas pengeluaran dan akses pengguna. Anda dapat mengotomatisasi pembuatan kartu, menetapkan batas bulanan, dan memantau aktivitas, yang menyederhanakan operasi untuk bisnis yang berkembang. Selain itu, mitra di bidang akuntansi atau HR dapat memanfaatkan Onboarding API untuk membuat tautan rujukan yang dipersonalisasi, meningkatkan proses akuisisi klien.

Namun, nilai sebenarnya terletak pada fleksibilitasnya. Anda mengintegrasikan Brex API dengan sistem yang ada untuk membuat dasbor atau peringatan khusus, memastikan bahwa data keuangan mengalir secara efisien di seluruh platform. Akibatnya, developer menghemat waktu dan mengurangi kesalahan dibandingkan dengan entri data manual.

Bagaimana Cara Memulai Akses Brex API?

Untuk memulai akses Brex API, Anda harus mendaftar akun Brex terlebih dahulu jika belum memilikinya. Kunjungi brex.com dan buat akun sebagai administrator, karena hanya admin akun atau admin kartu yang dapat membuat token API.

Selanjutnya, masuk ke dasbor Brex.

Navigasi ke bagian Developer di bawah Pengaturan. Di sini, Anda mengklik Buat Token untuk memulai proses. Anda memberikan nama untuk token tersebut, yang membantu dalam mengidentifikasi tujuannya nanti, seperti "Token Integrasi untuk Aplikasi."

Selain itu, Anda memilih cakupan yang sesuai selama langkah ini. Cakupan menentukan tingkat akses data, seperti akses baca ke transaksi atau izin tulis untuk manajemen pengguna. Setelah mengonfirmasi pilihan Anda, Anda mengklik Izinkan Akses, dan sistem akan menghasilkan token.

Penting, segera salin dan simpan token ini dengan aman, karena Brex mengaburkan token setelah pembuatan untuk alasan keamanan. Jika Anda kehilangannya, Anda cukup membuat yang baru. Token kedaluwarsa setelah 90 hari tidak aktif, jadi Anda pantau penggunaannya untuk menghindari gangguan.

Setelah Anda memiliki token, Anda dapat menguji konektivitas dasar. Misalnya, Anda menggunakan alat seperti curl untuk membuat permintaan GET sederhana ke titik akhir, termasuk token di header Otorisasi. Ini memverifikasi bahwa pengaturan Anda berfungsi dengan benar.

Bagaimana Cara Mengautentikasi dengan Brex API?

Anda mengautentikasi dengan Brex API menggunakan token pembawa (bearer tokens). Secara khusus, Anda menyertakan token di header Otorisasi dari setiap permintaan, diformat sebagai "Bearer {token_anda}".

Misalnya, pertimbangkan contoh curl ini:

curl -X GET https://platform.brexapis.com/v2/users/me \
-H "Authorization: Bearer bxt_jBWQLZXtu1f4sVT6UjaWPp7Gh9nVGjzEZgRX"

Permintaan ini mengambil detail pengguna saat ini. Jika berhasil, ini mengembalikan data JSON tentang pengguna.

Selain itu, Brex mendukung token pengguna, yang terkait dengan hak istimewa admin tertentu. Anda membuat token ini seperti yang dijelaskan sebelumnya, memastikan Anda memilih cakupan yang sesuai dengan kebutuhan Anda. Misalnya, jika Anda berencana untuk mengelola kartu, pilih cakupan untuk membaca dan menulis di titik akhir kartu.

Namun, jika token ter compromised, Anda segera mencabutnya dari halaman Developer di dasbor. Token yang dicabut menyebabkan panggilan API berikutnya gagal dengan kesalahan 401, melindungi akun Anda.

Dalam praktiknya, Anda menerapkan manajemen token di kode aplikasi Anda. Pustaka seperti modul `requests` Python menyederhanakan ini:

import requests

headers = {
    'Authorization': 'Bearer token_anda_di_sini'
}

response = requests.get('https://platform.brexapis.com/v2/users/me', headers=headers)
print(response.json())

Cuplikan kode ini menunjukkan otentikasi aktif dalam sebuah skrip.

Apa Saja Titik Akhir (Endpoints) Utama Brex API?

Brex API menawarkan berbagai titik akhir di berbagai API. Anda mulai dengan menjelajahi Team API, yang menangani pengguna, departemen, lokasi, kartu, dan lainnya.

Untuk pengguna, Anda membuat daftar semua pengguna dengan GET /v2/users, memfilter berdasarkan email atau ID. Parameter termasuk kursor untuk paginasi dan batas untuk mengontrol ukuran respons. Demikian pula, Anda mengundang pengguna baru melalui POST /v2/users, menyediakan first_name, last_name, email, dan manager_id opsional.

Selanjutnya, Anda memperbarui pengguna dengan PUT /v2/users/{id}, mengubah status menjadi AKTIF atau DINONAKTIFKAN. Anda juga menetapkan batas bulanan menggunakan POST /v2/users/{id}/limit, menentukan jumlah dalam badan permintaan.

Untuk departemen, Anda membuat satu dengan POST /v2/departments, yang memerlukan nama. Anda membuat daftar departemen melalui GET /v2/departments, dan mengambil detail spesifik dengan GET /v2/departments/{id}.
Lokasi mengikuti pola serupa: POST /v2/locations untuk pembuatan, GET /v2/locations untuk daftar.
Jabatan, yang mewakili peran pekerjaan, menggunakan titik akhir seperti POST /v2/titles dan GET /v2/titles/{id}.
Kartu merupakan bagian inti. Anda membuat daftar kartu dengan GET /v2/cards, difilter berdasarkan user_id. Untuk membuat kartu, POST /v2/cards dengan detail seperti pemilik, card_type (VIRTUAL atau PHYSICAL), dan spend_controls. Spend_controls mencakup limit_type dan amounts.

Selain itu, Anda memperbarui kartu melalui PUT /v2/cards/{id}, menguncinya dengan POST /v2/cards/{id}/lock (menyediakan alasan seperti FRAUD), atau menghentikannya dengan POST /v2/cards/{id}/terminate.

Operasi sensitif meliputi GET /v2/cards/{id}/pan untuk nomor kartu dan POST /v2/cards/{id}/secure_email untuk mengirim detail dengan aman.
Entitas hukum dan perusahaan memiliki titik akhir hanya-baca seperti GET /v2/legal_entities dan GET /v2/company.
Beralih ke Transactions API, Anda mengambil transaksi kartu yang telah diselesaikan dengan GET /v2/transactions/card/primary, menggunakan parameter seperti posted_at_start untuk pemfilteran tanggal. Untuk akun kas, GET /v2/transactions/cash/{id} membuat daftar transaksi.
Titik akhir akun meliputi GET /v2/accounts/card untuk akun kartu dan GET /v2/accounts/cash untuk akun kas. Anda mengambil laporan dengan GET /v2/accounts/card/primary/statements.
Onboarding API berfokus pada rujukan. Anda membuat rujukan dengan POST /v1/referrals, menyediakan referral_code dan detail pelamar. Buat daftar rujukan melalui GET /v1/referrals, dan dapatkan detail spesifik dengan GET /v1/referrals/{id}. Unggahan dokumen menggunakan POST /v1/referrals/{id}/document_upload.

API lain termasuk Pembayaran untuk transfer (GET /v2/transfers), Webhook untuk notifikasi, dan Fields API untuk mengelola bidang khusus.

Semua titik akhir daftar mendukung paginasi dengan kursor dan batas, memastikan pengambilan data yang efisien.

Bagaimana Cara Menggunakan Brex API untuk Transaksi?

Anda menggunakan Brex API untuk transaksi dengan memanggil titik akhir di Transactions API. Pertama, Anda mengidentifikasi jenis akun—kartu atau kas.

Untuk transaksi kartu, Anda mengirim GET /v2/transactions/card/primary. Ini mengembalikan pembelian, pengembalian dana, dan chargeback yang diselesaikan. Anda dapat memfilter berdasarkan user_ids atau posted_at_start, seperti "2025-01-01T00:00:00Z".

Respons mencakup detail seperti jumlah, deskripsi, pedagang, dan expense_id jika diperluas.

Untuk transaksi kas, Anda menentukan ID akun di GET /v2/transactions/cash/{id}. Ini membuat daftar semua aktivitas untuk akun kas tersebut.

Untuk mengelola akun, Anda membuat daftar akun kartu dengan GET /v2/accounts/card, yang mengembalikan ID dan status. Demikian pula, GET /v2/accounts/cash menyediakan detail akun kas.

Selain itu, Anda mengambil laporan untuk audit. Gunakan GET /v2/accounts/card/primary/statements untuk mendapatkan laporan kartu yang telah difinalisasi, dipaginasi sesuai kebutuhan.

Dalam kode, Anda mengimplementasikannya sebagai berikut (contoh Python):

import requests

headers = {
    'Authorization': 'Bearer token_anda_di_sini'
}

params = {
    'posted_at_start': '2025-12-01T00:00:00Z',
    'limit': 50
}

response = requests.get('https://platform.brexapis.com/v2/transactions/card/primary', headers=headers, params=params)
transactions = response.json()['items']
for tx in transactions:
    print(f"Jumlah: {tx['amount']['amount']}, Deskripsi: {tx['description']}")

Skrip ini mengambil dan mencetak transaksi terbaru, menunjukkan penggunaan praktis.

Selain itu, Anda menangani kesalahan seperti 404 untuk ID yang tidak valid dengan memeriksa response.status_code.

Bagaimana Cara Mengelola Tim dengan Brex Team API?

Anda mengelola tim menggunakan titik akhir Team API. Mulai dengan membuat daftar pengguna dengan GET /v2/users. Ini membantu Anda mengaudit anggota tim saat ini.

Untuk menambahkan pengguna, POST /v2/users dengan bidang yang diperlukan:

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "department_id": "dept_123"
}

Sistem secara otomatis mengirimkan email undangan.

Anda memperbarui detail pengguna, seperti menetapkan manajer baru, melalui PUT /v2/users/{id}.

Untuk kontrol pengeluaran, POST /v2/users/{id}/limit menetapkan anggaran bulanan.

Departemen dan lokasi meningkatkan organisasi. Anda membuat departemen dengan POST /v2/departments:

{
  "name": "Teknik",
  "description": "Tim pengembangan perangkat lunak"
}

Kemudian, tetapkan pengguna ke departemen tersebut selama undangan atau pembaruan.

Kartu terikat pada pengguna. Anda membuat kartu virtual untuk pengguna:

{
  "owner": {
    "user_id": "user_456"
  },
  "card_name": "Kartu Proyek",
  "card_type": "VIRTUAL",
  "limit_type": "CARD",
  "spend_controls": {
    "limit": {
      "amount": 5000,
      "currency": "USD"
    }
  }
}

POST ini ke /v2/cards.

Nanti, Anda dapat mengunci kartu jika diperlukan: POST /v2/cards/{id}/lock dengan alasan "LAINNYA".

Pendekatan ini memastikan manajemen tim yang aman.

Mengintegrasikan Brex API dengan Aplikasi Anda: Contoh Kode

Anda mengintegrasikan Brex API dengan memasukkan panggilan API ke dalam codebase Anda. Gunakan pustaka seperti `requests` di Python atau axios di JavaScript.

Untuk contoh Node.js, instal axios:

npm install axios

Kemudian, ambil pengguna:

const axios = require('axios');

const headers = {
  Authorization: 'Bearer token_anda_di_sini'
};

axios.get('https://platform.brexapis.com/v2/users', { headers })
  .then(response => {
    console.log(response.data.items);
  })
  .catch(error => {
    console.error(error.response.data);
  });

Ini mencatat data pengguna.

Untuk integrasi yang lebih kompleks, Anda menggunakan webhook. Berlangganan acara melalui Webhooks API, menyiapkan titik akhir untuk menerima notifikasi tentang pembaruan transaksi.

Di Python, tangani paginasi untuk kumpulan data besar:

def fetch_all_users(headers, cursor=None):
    users = []
    while True:
        params = {'limit': 100, 'cursor': cursor}
        response = requests.get('https://platform.brexapis.com/v2/users', headers=headers, params=params)
        data = response.json()
        users.extend(data['items'])
        cursor = data['next_cursor']
        if not cursor:
            break
    return users

Fungsi ini mengambil semua pengguna secara iteratif.

Anda juga mengamankan data sensitif, seperti nomor kartu, dengan menggunakan GET /v2/cards/{id}/pan hanya jika diperlukan dan tidak menyimpan apa pun secara lokal.

Bagaimana Anda Bisa Menguji Brex API dengan Apidog?

Anda menguji Brex API secara efektif menggunakan Apidog, platform lengkap untuk pengembangan API. Apidog memungkinkan Anda merancang, men-debug, mem-mock, menguji, dan mendokumentasikan API secara intuitif.

Selanjutnya, siapkan otentikasi dengan menambahkan token pembawa Anda di variabel global atau pengaturan lingkungan. Ini berlaku untuk semua permintaan.

Anda kemudian mengirim permintaan, seperti GET /v2/users/me, dan melihat respons dalam antarmuka yang ramah pengguna. Apidog menyoroti struktur JSON dan kesalahan.

Terlebih lagi, Anda membuat skenario pengujian dengan pernyataan. Misalnya, pastikan respons transaksi memiliki status 200 dan berisi 'jumlah'.

Fitur mocking Apidog mensimulasikan respons untuk titik akhir yang tidak tersedia, membantu pengembangan.

Selain itu, hasilkan dokumentasi dengan contoh kode dalam berbagai bahasa, bagikan dengan tim Anda.

Dengan menggunakan Apidog, Anda menyederhanakan pengujian Brex API, menangkap masalah sejak dini.

Apa Saja Praktik Terbaik untuk Menggunakan Brex API?

Anda mengikuti praktik terbaik untuk mengoptimalkan penggunaan Brex API. Selalu gunakan HTTPS dan simpan token dengan aman, mungkin dalam variabel lingkungan atau vault.

Terapkan penanganan pembatasan tarif, karena Brex memberlakukan batas—coba lagi dengan backoff eksponensial pada kesalahan 429.

Paginasikan permintaan untuk menghindari batas waktu; gunakan kursor dan batas secara konsisten.
Pantau kedaluwarsa token dan otomatiskan pembaruan.
Validasi input sebelum dikirim untuk mencegah kesalahan 400.
Catat panggilan API untuk debugging, tetapi anonimkan data sensitif.
Gunakan kunci idempoten untuk POST/PUT untuk menghindari duplikat.
Integrasikan penanganan kesalahan: Petakan kode HTTP ke tindakan, seperti menyegarkan token pada 401.
Uji di lingkungan staging sebelum produksi.
Tetap perbarui dengan changelog Brex untuk perubahan.

Praktik-praktik ini memastikan integrasi yang andal.

Masalah Umum dan Cara Memecahkan Masalah Brex API?

Anda mungkin menghadapi masalah seperti kegagalan otentikasi. Jika Anda mendapatkan 401, periksa validitas token—buat ulang jika kedaluwarsa.

Untuk 403 Terlarang, verifikasi cakupan sesuai dengan titik akhir.
404 Tidak Ditemukan sering berarti ID tidak valid; periksa ulang jalur.
Batas tarif terlampaui menghasilkan 429; terapkan backoff.
Kesalahan jaringan memerlukan logika percobaan ulang.

Gunakan koleksi Brex Postman untuk pengujian awal, dengan mengfork dari ruang kerja mereka.

Jika masalah berlanjut, konsultasikan dokumen atau hubungi dukungan.

Kesimpulan

Anda sekarang memahami cara mengakses dan menggunakan Brex API secara komprehensif. Mulai dari otentikasi hingga penggunaan titik akhir dan pengujian dengan Apidog, langkah-langkah ini memungkinkan integrasi yang tangguh. Terapkan untuk meningkatkan alur kerja keuangan Anda secara efisien.

tombol