Aksè API
Dokimantasyon patnè

Kijan aksè API patnè a fonksyone

Twa bagay travay ansanm: aplikasyon w lan, apwobasyon nivo a, epi kle API a. Konprann ki wòl chak youn genyen anpeche move sipriz nan entegrasyon w.

1. Aplikasyon an

api_access_requests

Lè w soumèt fòm nan, nou kreye yon dosye aplikasyon ki gen non legal òganizasyon w, estati li, nimewo anrejistreman, ka itilizasyon, nivo w mande a ak scope yo. Dosye a rete nan estati « an atant » epi se sèl ou menm ak ekip revizyon an ki ka wè l.

  • • Yon sèl dosye aktif pa òganizasyon.
  • • Chak chanjman etap kite yon tras ou ka swiv nan tablo w la.
  • • Nou ka mande plis enfòmasyon san w pa pèdi dosye a.

2. Apwobasyon nivo a

api_access_grant

Lè ekip la apwouve dosye a, li tounen sous verite pou dwa w yo: nivo (tier), scope yo, limit demann pa minit, ak dat pwochen revizyon an. Se pa kle a ki defini dwa w — se apwobasyon an. Si nou desann nivo w oswa revizyon w ekspire, tout kle w yo pèdi dwa a menm kote a.

  • • Staging louvri anvan pwodiksyon.
  • • Pwodiksyon mande verifikasyon dokiman fin fèt.
  • • Apwobasyon an gen yon dat re-revizyon; apre dat sa a aksè pwodiksyon an fèmen.

3. Kle API a

api_keys

Kle a se sèlman yon idantifyan pou machin ou. Nou montre l yon sèl fwa; nou konsève yon anprint sèlman. Chak demann verifye kle a, li apwobasyon ki dèyè l la, epi aplike scope ak limit ki soti nan apwobasyon an — pa nan kle a.

  • • Kle staging ak kle pwodiksyon separe.
  • • Ou ka fè wotasyon oswa dezaktive yon kle nenpòt kilè.
  • • Chak apèl anrejistre: endpoint, estati, dire ak IP.

Chemen konplè a

  1. 1Ou soumèt aplikasyon an → dosye a kreye ak estati « an atant ».
  2. 2Ou voye dokiman yo → ekip la egzamine chak grenn.
  3. 3Apwobasyon an bay nivo, scope ak limit → staging louvri.
  4. 4Verifikasyon fini → pwodiksyon louvri ak yon dat re-revizyon.
  5. 5Ou jenere yon kle → chak demann li dwa yo nan apwobasyon an.
  6. 6Re-revizyon oswa revokasyon → kle a rete, men dwa yo fèmen.

Sa pou w prepare

Men chan fòm nan mande yo. Ranmase yo anvan ou kòmanse.

Non òganizasyon an

obligatwa

Non legal konplè jan l ekri nan papye anrejistreman an.

org_name

Tip òganizasyon

obligatwa

Medya, ONG, lopital, inivèsite, ajans leta oswa antrepriz.

org_type

Estati legal

obligatwa

Egzanp: ONG rekonèt pa MPCE, sosyete anonim, enstitisyon piblik.

legal_status

Nimewo anrejistreman / NIF

obligatwa

Nimewo ki parèt sou sètifika anrejistreman oswa kat fiskal la.

registration_no

Imel kontak ofisyèl

obligatwa

Yon imel domèn òganizasyon an — pa yon imel pèsonèl.

contact_email

Kontak teknik

opsyonèl

Moun k ap entegre API a ak imel oswa telefòn li.

technical_contact

Sit entènèt

opsyonèl

Sit ofisyèl oswa paj rezo sosyal ki aktif.

website

Nivo aksè w mande

obligatwa

Tier 1 pou estatistik ajreje jiska Tier 5 pou aksè ofisyèl ijans.

tier

Scope yo

obligatwa

stats:read, incidents:read, businesses:read — selon nivo a.

scopes

Ka itilizasyon

obligatwa

Esplike ki jan w pral sèvi ak done yo epi ki moun k ap wè yo.

use_case

Volim ou prevwa chak jou

opsyonèl

Yon estimasyon demann pa jou pou nou ka fikse limit la.

expected_volume_per_day

Akò itilizasyon done

obligatwa

Ou dwe aksepte akò a: pa gen re-idantifikasyon, pa gen revant done.

agreement_accepted_at

Dokiman yo mande

  • Sètifika anrejistreman — Papye ki pwouve òganizasyon an egziste legalman.
  • Nimewo fiskal / NIF — Dokiman fiskal ki koresponn ak non an.
  • Pyès idantite reprezantan — Idantite moun ki siyen aplikasyon an.
  • Lèt otorizasyon — Lèt sou papye antèt ki otorize reprezantan an aji pou òganizasyon an.
  • Politik pwoteksyon done — Kijan w konsève epi pwoteje done ou resevwa yo (Tier 3+).
Limit ki pa chanje

Sa API a pa janm bay

  • • Okenn nivo API pa janm resevwa non, kont, aparèy oswa telefòn yon moun ki rapòte.
  • • Tout repons API pase nan yon baryè anonimizasyon anvan yo kite sèvè a.
  • • Chak demann anrejistre; itilizasyon abizif fè kle a sispann otomatikman.
Kreye kont epi aplike Wè nivo aksè yo