DocsAutenticacion
Aprende a autenticarte con la API de Cost+
Toda comunicacion con la API de Cost+ requiere TLS 1.2 o superior y autenticacion HTTP Basic.
Como funciona la autenticacion Basic
Autenticate usando tu clave API como nombre de usuario con una contrasena vacia. Codifica en Base64 la cadena \{api_key\}: (observa los dos puntos finales — la contrasena esta vacia).
El encabezado Authorization resultante tiene este aspecto:
Authorization: Basic aHVudGVyMjo=Nunca expongas tu clave API en codigo del lado del cliente ni en repositorios publicos. Mantenla unicamente en el servidor.
Uso con cURL
Forma nativa (recomendada)
cURL soporta de forma nativa la autenticacion Basic con el flag -u. Pasa tu clave API seguida de dos puntos:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Codificacion Base64 manual
Si prefieres construir el encabezado manualmente, primero codifica la clave:
echo -n "YOUR_API_KEY:" | base64Luego pasa el valor codificado en el encabezado Authorization:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Los dos puntos finales despues de la clave API son obligatorios — separan el nombre de usuario de la contrasena (vacia) en el esquema de autenticacion Basic.
Codigos de estado HTTP
La API utiliza codigos de estado HTTP estandar para indicar el resultado de una solicitud.
| Codigo de estado | Significado | Descripcion |
|---|---|---|
| 200 | OK | La solicitud se realizo correctamente. |
| 201 | Creado | El recurso se creo correctamente. |
| 400 | Solicitud incorrecta | La solicitud estaba mal formada o le faltan campos obligatorios. |
| 401 | No autorizado | La autenticacion fallo — verifica tu clave API. |
| 403 | Prohibido | No tienes permiso para acceder a este recurso. |
| 404 | No encontrado | El recurso solicitado no existe. |
| 500 | Error interno del servidor | Algo salio mal en nuestro lado. |
| 502 | Bad Gateway | Error del servicio upstream. |
| 503 | Servicio no disponible | La API no esta disponible temporalmente. |
| 504 | Gateway Timeout | El servicio upstream no respondio a tiempo. |