Mga integration at REST API: paano ito gumagana
Pinapayagan ng Integrations & API ang ibang software na gumana sa iyong data. Ang API key ay nagbibigay-daan sa ibang system na magbasa ng mga customer, lead, quotation, invoice, order at produkto at gumawa ng ilan sa mga ito, at sinasabihan ng mga webhook ang ibang system sa mismong sandaling may mangyari dito. Gamitin ito para ikonekta ang mga accounting tool, automation service o sarili mong app.
Aralin 2 sa 9 · Paano ito gumagana
Paano ito gumagana
Ipinapakita ng «System → Integrations → Integrations & API» ang apat na numero sa itaas: «Active keys», «Endpoints», «Delivered (7 d)» at «Failed». Sa ibaba ay ang mga panel na «API keys», «Webhook endpoints» at «Event catalog».
Pindutin ang «Create key», bigyan ito ng pangalang nagsasabi kung saan ito ginagamit, i-tsek ang mga scope nito at, kung gusto mo, maglagay ng expiry date. Ang scope ay ang karapatang magbasa o magsulat ng isang uri ng record. Kasama na ang read sa write.
Isang beses lang ipinapakita ang bagong key sa ilalim ng «Your new API key». Kopyahin ito agad: fingerprint lang nito ang naiimbak, kaya hindi na ito maipapakita ulit.
Ipinapadala ng ibang system ang key sa bawat request. Kaya nitong maglista at magbasa ng mga customer, lead, quotation, invoice, order at produkto, at kaya nitong gumawa ng mga customer, lead, draft na quotation at draft na invoice.
Ang lead na ginawa sa pamamagitan ng API ay nagpapadala ng parehong mga mensahe gaya ng form sa website. Ang mga quotation at invoice na ginawa sa API ay laging draft, at kinukuwenta ang tax gaya ng sa admin editor. Hindi kailanman ipinapadala ng API ang mga ito o minamarkahang bayad.
Ipinapakita ng bawat row ng key ang mga scope nito, kung sino ang gumawa, ang bilang ng request at ang huling paggamit, kasama ang badge na «Active», «Expired» o «Revoked». Agad na pinapahinto ng «Revoke» ang isang key.
Binubuksan ng «API docs» ang buong reference para sa developer, at binubuksan ng «Delivery log» ang listahan ng mga webhook post.
Saan ito makikita
- System → Integrations → Integrations & API
/admin/integrations - Integrations & API → API docs
/admin/integrations/docs - Integrations & API → Delivery log
/admin/integrations/deliveries
Mga setting na nagbabago nito
- Apps & modules (Automation & integrations)
/admin/apps
Listahan ng gagawin
Bago magpatuloy, tiyaking kaya mong:
- Buksan ang System → Integrations → Integrations & API
- Ipinapakita ng System → Integrations → Integrations & API ang apat na numero sa itaas: Active keys,…
- Pindutin ang Create key, bigyan ito ng pangalang nagsasabi kung saan ito ginagamit, i-tsek ang mga scope…
- Isang beses lang ipinapakita ang bagong key sa ilalim ng Your new API key.
- Ipinapadala ng ibang system ang key sa bawat request.
Mga tip at karaniwang pagkakamali
- Nawala ang key? Hindi na ito mababawi. I-revoke ang luma at gumawa ng bago.
- Kapag tinanggihan ang request dahil sa kulang na scope, ibig sabihin ginawa ang key nang wala ang karapatang iyon. Gumawa ng bagong key na naka-tsek ang scope.
- Puwedeng gumawa ang isang key ng 300 request nang sabay-sabay at pagkatapos ay 5 kada segundo. Ang system na mas mabilis humingi ay pinaghihintay, at ang paulit-ulit na pagtanggi mula sa isang address ay puwedeng humantong sa pansamantalang ban.
- Ituring ang key na parang password. Bigyan ang bawat nakakonektang system ng sarili nitong key, para ma-revoke mo ang isa nang hindi napapahinto ang iba.