Vés 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 importar dades a una altra eina. Aquesta pàgina cobreix les convencions que s'apliquen a tots els punts de connexió; cada punt de connexió individual es documenta a la seva pròpia pàgina.

URL base​

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

El segment v1 és la versió de l'API. Snapbyte mai no trencarà una versió publicada; els comportaments nous s'incorporen sota un nou prefix de versió.

Autenticació​

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

Authorization: Bearer sk_live_replace_me

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

Estructura de les sol·licituds i les respostes​

  • Tots els cossos de sol·licitud són JSON. Definiu 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 un prefix (per exemple, job_01h...) perquè siguin autodescriptius als registres.

Format dels errors​

Els errors es retornen 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 es pot fer servir amb seguretat per ramificar la lògica; message és per a les persones i pot canviar.

Límits de freqüència​

Snapbyte aplica límits de freqüència per clau. Cada resposta inclou:

CapçaleraSignificat
x-snapbyte-ratelimitSol·licituds permeses dins de la finestra.
x-snapbyte-remainingSol·licituds restants dins de la finestra.
x-snapbyte-resetMarca de temps Unix de reinici de la finestra.

En rebre un 429, espereu fins a l'hora de reset. L'SDK ho fa per vosaltres.

Paginació​

Els punts de connexió de llistat es paginen amb cursor:

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

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

On anar a continuació​

  • Guies per a guies pràctiques orientades a tasques de l'Admin Hub.
  • Resolució de problemes per saber què fer quan una sol·licitud falla.