API REST per a desenvolupadors

API REST és la interfície a través de la qual pot controlar tots els serveis que ha adquirit amb nosaltres.

Cada sol·licitud d'API s'ha d'autoritzar mitjançant la capçalera HTTP amb el valor Bearer TOKEN.

Per administrar els Token accedeixi a l'edició del compte d'usuari a l'Àrea de Client.

 

Com activar la interfície API REST

L'activació de l'API no està vinculada a cap compte amb permisos especials. Simplement creï i activi el que s'anomena token en el seu compte de client, o també pot crear un nou compte.

Pot crear un nou token a l'Àrea de Client a la secció d'Edició de dades del Client. Trobarà l'accés a la gestió d'API a la part inferior de la pàgina.

És possible crear diversos tokens, que s'utilitzaran per autoritzar sol·licituds REST.

ADVERTÈNCIA: els tokens no es poden administrar o crear des d'un compte de persona de contacte. Sempre és necessari utilitzar un compte d'empresa "principal" o un compte personal.

 

Instrucciones detallades:

  1. Amb les seves dades d'accés, iniciï sessió a l'Àrea de Client. Si no disposa de les seves dades d'accés pot sol·licitar una nova contrasenya.
  2. A la cantonada superior dreta, faci clic al nom de l'empresa/nom d'usuari. Com a alternativa, faci servir l'enllaç a l'administració d'API i vagi al pas 4.                                                                                                                                                                                                             
  3. Vagi a la part inferior de la pàgina i faci clic a API. Ara podrà accedir a l'administració d'API.
  4. Faci clic a "Crear nou token". 
  5. En el camp opcional "comentaris" pot escriure una descripció que l'ajudi a identificar els diferents tokens creats.
  6. Estableixi una data de caducitat, o deixi el camp en blanc per a una durada indefinida
  7. En la restricció d'accés pot especificar l'adreça IP del dispositiu habilitat per al funcionament del token. Si un dispositiu amb una altra adreça IP vol utilitzar un token, no es compliran els requisits, i no s'autoritzarà la sol·licitud.
  8. Tan aviat com hagi completat tot el que necessita, pot Afegir un nou token. Per a això, cal confirmar la contrasenya del seu compte de client.

 

Administració de Tokens

L'administració de tots els tokens creats la pot fer a l'Àrea de Client

Per a això ha d'accedir a la secció Editar les dades del seu compte de client, al final de la pàgina en l'apartat API. Per raons de seguretat, serà necessari introduir novament la contrasenya del compte de client.

Després de fer clic a Detall, trobarà les opcions per editar la descripció del token o establir les seves limitacions, ja sigui la data de caducitat o permetre l'accés des d'una adreça IP específica.

La restricció de l'adreça IP només funciona per a una adreça IP o màscara en la notació CIDR. Si necessita limitar l'accés des de diverses adreces, ha de configurar un nou token per a cada IP.

Els tokens creats es poden desactivar en qualsevol moment. La desactivació del token pot trigar fins a 10 minuts a ser efectiva.

Els tokens desactivats no es poden eliminar completament, seran enregistrades en el compte perquè l'usuari sempre pugui esbrinar quins tokens van ser utilitzats en el passat

 

Entorn de desenvolupament - sandbox

Cada sol·licitud enviada a través de l'API s'ha d'autoritzar mitjançant la capçalera HTTP HTAR Bearer TOKEN.      

Abans de crear el seu propi token, només pot usar l'entorn de proves al servidor a través de l'URL segura https://sandboxapi.active24.com. Un token vàlid per a aquest entorn sandbox és 123456qwerty-ok.

Les sol·licituds en l'entorn sandbox no realitzen cap canvi en el sistema o el servei, s'utilitzen únicament per a comprovar la validesa de les sol·licituds.

La documentació per l'entorn del desenvolupador està disponible a https://sandboxapi.active24.com.


Entorn de producció i documentació.

L'entorn de producció de l'API REST s'executa al servidor només a través del port protegit https://api.active24.com.

Per a les especificacions de tots els mètodes disponibles a l'API, consulti la documentació a https://api.active24.com.