Salta al contingut principal

Visió general de l'API

L'API de Snapbyte és una API REST que parla JSON sobre HTTPS. Està pensada per als equips que volen connectar Snapbyte amb els seus propis sistemes —sincronitzar cartes, reaccionar a comandes o extraure dades cap a una altra eina—. Esta pàgina cobrix les convencions que s'apliquen a cada endpoint; els endpoints individuals es documenten en les seues pròpies pàgines.

URL base​

https://api.snapbyte.app/api/v1

El segment v1 és la versió de l'API. Snapbyte mai trencarà una versió publicada; el comportament nou s'incorpora sota un prefix de versió nou.

Autenticació​

Totes les sol·licituds han d'incloure un token de portador (bearer):

Authorization: Bearer sk_live_replace_me

Les claus estan limitades a un entorn (sandbox o production).

Estructura de la sol·licitud i la resposta​

  • Tots els cossos de les sol·licituds són JSON. Establix Content-Type: application/json.
  • Totes les respostes són JSON, fins i tot en cas d'error.
  • Les marques de temps són cadenes ISO 8601 en UTC.
  • Els identificadors duen prefix (per exemple, job_01h...) perquè siguen autodescriptius en els registres.

Format dels errors​

Els errors tornen amb un estat diferent de 2xx i un cos estructurat:

{
"error": {
"code": "invalid_request",
"message": "payload.message is required",
"param": "payload.message"
}
}

El camp code és estable i és segur fer-hi distincions; el message és per a les persones i pot canviar.

Límits de velocitat​

Snapbyte aplica límits de velocitat per clau. Cada resposta inclou:

CapçaleraSignificat
x-snapbyte-ratelimitSol·licituds permeses en la finestra.
x-snapbyte-remainingSol·licituds restants en la finestra.
x-snapbyte-resetMarca de temps Unix de quan es reinicia la finestra.

Davant d'un 429, espera fins a l'hora de reset. L'SDK ho fa per tu.

Paginació​

Els endpoints de llista es paginen amb cursor:

GET /v1/jobs?limit=50&cursor=eyJ...

La resposta inclou un next_cursor (o null quan has arribat al final). Els cursors són opacs: no intentes analitzar-los.

On anar a continuació​