Pengenalan

Selamat datang di referensi API Mailtarget. Ikuti panduan ini untuk memulai.

API Mailtarget dibangun di atas protokol HTTP. API kami bersifat RESTful dan memiliki karakteristik berikut:

Menggunakan URL yang konsisten dan terstruktur, sehingga mudah diprediksi.
Memanfaatkan kemampuan bawaan HTTP untuk pengiriman parameter dan autentikasi.
Menggunakan kode respons HTTP standar untuk menunjukkan kesalahan.
Memberikan respons dalam format JSON.

Mailtarget menyediakan pustaka untuk berbagai bahasa pemrograman. Anda dapat memilih untuk menggunakan pustaka kami atau pustaka HTTP/REST favorit Anda yang kompatibel dengan bahasa pemrograman yang Anda gunakan untuk membuat permintaan HTTP ke Mailtarget. Kami menyarankan Anda mengunjungi halaman pustaka kami, di mana kami memberikan rekomendasi pustaka HTTP REST.

Endpoint

Semua panggilan ke API harus dimulai dengan URL dasar yang sesuai:

Mailtarget production

https://transmission.mailtarget.co/v1

Autentikasi

Autentikasi setiap permintaan dilakukan dengan mengatur header Authorization menggunakan API key yang valid.

Kami menerima API key berikut untuk lingkungan sandbox:

"Authorization": provided in sandbox dashboard

Kami menerima API key berikut untuk lingkungan production:

"Authorization": provide for user production

Konvensi API

Tanda garis miring di akhir URL akan diabaikan: /transmissions sama dengan /transmissions/.
Jalur URL, nama parameter kueri URL, dan nama bidang JSON bersifat case-sensitive (membedakan huruf besar dan kecil).
Jalur URL ditulis dengan huruf kecil, menggunakan tanda hubung untuk memisahkan kata.
Parameter kueri dan bidang JSON menggunakan format camelCase.
Status HTTP menunjukkan apakah operasi berhasil atau gagal, dengan informasi tambahan disertakan dalam respons HTTP.
Semua API mengembalikan format kode kesalahan HTTP standar.
Parameter kueri dan bidang permintaan yang tidak diharapkan akan diabaikan.
Tipe angka JSON kami dibatasi hingga bilangan bulat 32-bit bertanda.

Kesalahan

Saat melakukan panggilan API, Anda mungkin menerima pesan kesalahan dalam respons. Pesan kesalahan ini dapat menunjukkan adanya masalah dengan permintaan Anda atau kesalahan yang terjadi di pihak kami. Kesalahan akan disertai dengan kode kesalahan dan data JSON yang memberikan pesan, deskripsi, dan kode API yang lebih spesifik.

Berikut adalah tabel terjemahan dalam bahasa Indonesia:

KODE	NAMA STATUS	DESKRIPSI	TINDAKAN YANG DISARANKAN
400	Permintaan Tidak Valid	Ada masalah dengan permintaan Anda.	Periksa apakah permintaan Anda sesuai dengan dokumentasi API dan menggunakan sintaksis yang benar.
401	Tidak Terautentikasi	Anda tidak memiliki otorisasi yang diperlukan untuk membuat permintaan ini.	Pastikan Anda menggunakan API key yang valid dengan izin yang diperlukan untuk permintaan Anda.
403	Dilarang	Server memahami permintaan tetapi menolak untuk memenuhinya.	Periksa apakah paket Mailtarget Anda mencakup sumber daya yang diminta dan apakah API key Anda memiliki izin yang diperlukan.
404	Tidak Ditemukan	Server tidak dapat menemukan file yang diminta.	Ubah URL permintaan Anda agar sesuai dengan endpoint API yang valid.
405	Metode Tidak Diizinkan	Sumber daya tidak memiliki metode yang ditentukan. (misalnya, PUT pada transmissions)	Ubah metode agar sesuai dengan dokumentasi untuk sumber daya tersebut.
409	Konflik	Terjadi konflik akibat permintaan Anda. (misalnya, pengguna sudah ada dengan email tersebut)	Modifikasi payload untuk mengatasi konflik tersebut.
413	Entitas Permintaan Terlalu Besar	Ukuran permintaan melebihi batas yang ditentukan.	Periksa batas yang didokumentasikan untuk API dan kurangi ukuran permintaan Anda.
415	Media Tidak Didukung	Permintaan tidak dalam format yang didukung.	Periksa apakah header Content-Type Anda adalah tipe yang didukung dan apakah permintaan Anda sesuai dengan dokumentasi.
420	Melebihi Batas Pengiriman	Anda telah melebihi batas pengiriman harian, bulanan, atau sandbox.	Pastikan Anda masih dalam batasan paket Mailtarget Anda. Jika menggunakan domain sandbox, tambahkan domain pengiriman untuk melanjutkan.
422	Entitas Tidak Dapat Diproses	Permintaan secara sintaks benar tetapi gagal karena kesalahan semantik.	Pastikan permintaan Anda mencakup semua bidang yang diperlukan dan data Anda valid.
429	Terlalu Banyak Permintaan	Anda mengirim terlalu banyak permintaan dalam jangka waktu tertentu.	Tunggu 1 hingga 5 detik sebelum membuat permintaan lain. Pola penggunaan yang lebih berat mungkin memerlukan strategi backoff yang lebih canggih dan bertahap.
500	Kesalahan Server Internal	Terjadi masalah di sisi kami.	Coba lakukan permintaan lagi nanti. Jika kesalahan tidak terselesaikan, periksa pembaruan layanan. Anda juga dapat menghubungi Dukungan jika masalah terus berlanjut.
503	Layanan Tidak Tersedia	Kami mengalami tingkat lalu lintas yang lebih tinggi dari biasanya.	Coba lakukan permintaan lagi nanti.