> ## Documentation Index > Fetch the complete documentation index at: https://docs.sheeping.io/llms.txt > Use this file to discover all available pages before exploring further. # 1.- Consultar cuenta > Este endpoint devuelve la información general de la cuenta del usuario. La respuesta incluye datos de identificación, estado de la cuenta, métricas de uso, saldo disponible, información de contacto, dirección registrada y un identificador único de la transacción. Esta información es utilizada para consultar el estado actual de la cuenta y validar que el usuario cuente con los datos necesarios para operar dentro de nuestro sistema. ## OpenAPI ````yaml /openapi.json get /v1/customer-account openapi: 3.0.0 info: title: SHEEPING.IO - MODULO API version: 1.0.0 description: >- Nuestro **Módulo API** está basado en el protocolo **REST**. Todas las respuestas de las peticiones se entregan en formato **JSON** (y, en casos específicos, **HTML**). A través de los distintos **endpoints**, podrás consultar y gestionar información relacionada con **envíos**, usuarios y procesos asociados a la plataforma. Este módulo cuenta con **dos entornos disponibles**: - **Sandbox (Pruebas)** - **Producción** Para acceder a cada entorno es necesario contar con el **token de autenticación correspondiente**. ### Colección Postman El **Módulo Usuarios** proporciona una **colección en formato JSON compatible con Postman**, la cual incluye: - Ejemplos de solicitudes - Ejemplos de respuestas - Headers preconfigurados Se recomienda abrir este archivo directamente en **Postman** para facilitar la visualización, ejecución de pruebas y validación de cada endpoint de forma rápida y estructurada. --- ## URL Base y Versionado Todos los endpoints de la API están disponibles bajo la siguiente **URL base**: ``` https://apirest.sheeping.io/v1 ``` ### Versionado El **Módulo API** utiliza **versionado por URL**. En caso de futuras versiones (`/v2`, `/v3`, etc.), estas serán liberadas sin afectar las integraciones existentes. > Nota: Cualquier cambio relevante será notificado oportunamente para evitar interrupciones en los servicios ya integrados. --- ## Autenticación El **Módulo API** autenticación mediante **Bearer Token**. Cada solicitud HTTP debe incluir el token en el encabezado (`Header`) de la petición. ### Headers requeridos ``` Authorization: Bearer Content-Type: application/json ``` - El token identifica el ambiente y los permisos del cliente. - Sin un token válido, la API responderá con un **error de autenticación (401 Unauthorized)**. --- ## Ambientes disponibles El **Módulo Usuarios** proporciona **dos tokens de acceso**, uno por cada ambiente disponible. ### Sandbox (Pruebas) - Diseñado para **desarrollo y pruebas** - No genera envíos reales - No afecta datos de producción - Simula el comportamiento del entorno productivo ### Producción - Ambiente real y operativo - Genera **envíos y guías válidas** - Debe utilizarse **únicamente** después de validar la integración en Sandbox **Importante:** Es responsabilidad del usuario alternar correctamente entre los tokens de **Sandbox** y **Producción**, según el entorno en el que se encuentre trabajando. --- servers: - url: https://apirest.sheeping.io security: [] paths: /v1/customer-account: get: summary: 1.- Consultar cuenta description: >- Este endpoint devuelve la información general de la cuenta del usuario. La respuesta incluye datos de identificación, estado de la cuenta, métricas de uso, saldo disponible, información de contacto, dirección registrada y un identificador único de la transacción. Esta información es utilizada para consultar el estado actual de la cuenta y validar que el usuario cuente con los datos necesarios para operar dentro de nuestro sistema. parameters: - name: Authorization in: header schema: type: string example: Bearer responses: '200': description: 200 OK headers: Date: schema: type: string example: Mon, 05 Jan 2026 00:02:30 GMT Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive Server: schema: type: string example: cloudflare Nel: schema: type: string example: '{"report_to":"cf-nel","success_fraction":0.0,"max_age":604800}' Vary: schema: type: string example: Accept, Accept-Language, Origin Allow: schema: type: string example: GET, HEAD, OPTIONS Content-Language: schema: type: string example: es-mx X-Frame-Options: schema: type: string example: DENY X-Content-Type-Options: schema: type: string example: nosniff Referrer-Policy: schema: type: string example: same-origin Cross-Origin-Opener-Policy: schema: type: string example: same-origin cf-cache-status: schema: type: string example: DYNAMIC Report-To: schema: type: string example: >- {"group":"cf-nel","max_age":604800,"endpoints":[{"url":"https://a.nel.cloudflare.com/report/v4?s=EX9rGN%2BZQTSZzC%2FiUuBuxNjoRVrEJCP5Dd%2B%2Bj3kdQ9SSTJYc0kRGqjY0JkTn%2B5AsonYQNSlDQjNTRFkF5rpzxKjBmvj19p1CZhj54I9BR%2FeERczipUaM1SL3RVhQQGk%3D"}]} Content-Encoding: schema: type: string example: br CF-RAY: schema: type: string example: 9b8eb50b2bc3219e-GDL alt-svc: schema: type: string example: h3=":443"; ma=86400 content: application/json: schema: type: object properties: customer: type: object properties: user_id: type: string format: utc-millisec status: type: string shippings_count: type: integer balance: type: integer contact: type: object properties: first_name: type: string last_name: type: string email: type: string format: email phone: type: integer address: type: object properties: street: type: string street_number: type: string neighborhood: type: string zip_code: type: string format: utc-millisec city: type: string state: type: string transaction_id: type: string example: customer: user_id: '00000000' status: activo shippings_count: 0 balance: 0 contact: first_name: FIRST NAME last_name: LAST NAME email: user@email.com phone: 1234567890 address: street: STREET street_number: 1 INT 1 neighborhood: NEIGHBORHOOD zip_code: '12345' city: CITY state: STATE transaction_id: 9f2c7b3a-8d4a-4e9f-b1a2-6c7d8e9f0a12 '401': description: 401 Unauthorized headers: Date: schema: type: string example: Mon, 05 Jan 2026 00:29:45 GMT Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive Server: schema: type: string example: cloudflare Nel: schema: type: string example: '{"report_to":"cf-nel","success_fraction":0.0,"max_age":604800}' Vary: schema: type: string example: Origin X-Content-Type-Options: schema: type: string example: nosniff Referrer-Policy: schema: type: string example: same-origin Cross-Origin-Opener-Policy: schema: type: string example: same-origin cf-cache-status: schema: type: string example: DYNAMIC Report-To: schema: type: string example: >- {"group":"cf-nel","max_age":604800,"endpoints":[{"url":"https://a.nel.cloudflare.com/report/v4?s=y66qYISeMUIxtXvWAp8F4hZcLw6vrbMLhlZHJFjyiFI5tb1WGxelxA%2FHv9ST0mNd1ArzW4FgYWxxijrzo%2Bto%2B9yHUGVhui5XkardXZFmxwgZjNKHb3FP9gzONadKqrQ%3D"}]} CF-RAY: schema: type: string example: 9b8edcf64e0d21b3-GDL alt-svc: schema: type: string example: h3=":443"; ma=86400 '405': description: 405 Method Not Allowed headers: Date: schema: type: string example: Mon, 05 Jan 2026 00:28:45 GMT Content-Length: schema: type: integer example: 61 Connection: schema: type: string example: keep-alive Server: schema: type: string example: cloudflare Nel: schema: type: string example: '{"report_to":"cf-nel","success_fraction":0.0,"max_age":604800}' Vary: schema: type: string example: Accept, Accept-Language, Origin Allow: schema: type: string example: GET, HEAD, OPTIONS Content-Language: schema: type: string example: es-mx X-Frame-Options: schema: type: string example: DENY X-Content-Type-Options: schema: type: string example: nosniff Referrer-Policy: schema: type: string example: same-origin Cross-Origin-Opener-Policy: schema: type: string example: same-origin cf-cache-status: schema: type: string example: DYNAMIC Report-To: schema: type: string example: >- {"group":"cf-nel","max_age":604800,"endpoints":[{"url":"https://a.nel.cloudflare.com/report/v4?s=vG3KwSVEReNI0IWjemXiHoVy6isk0xXhv%2F5rmod%2Fv9WuYoupiCcgYF67Qv8QDkYMvnFYWg8epaHSIIcOk9LuOCAuF%2B70Ib4cPM1aQcf7Ujls9inMz27R%2FtqRfnmojIY%3D"}]} CF-RAY: schema: type: string example: 9b8edb808e8121b3-GDL alt-svc: schema: type: string example: h3=":443"; ma=86400 content: application/json: schema: type: object properties: detail: type: string status_code: type: integer example: detail: Método "POST" no permitido. status_code: 405 '500': description: 500 Internal Server Error headers: Date: schema: type: string example: Mon, 05 Jan 2026 00:28:45 GMT Content-Length: schema: type: integer example: 61 Connection: schema: type: string example: keep-alive Server: schema: type: string example: cloudflare Nel: schema: type: string example: '{"report_to":"cf-nel","success_fraction":0.0,"max_age":604800}' Vary: schema: type: string example: Accept, Accept-Language, Origin Allow: schema: type: string example: GET, HEAD, OPTIONS Content-Language: schema: type: string example: es-mx X-Frame-Options: schema: type: string example: DENY X-Content-Type-Options: schema: type: string example: nosniff Referrer-Policy: schema: type: string example: same-origin Cross-Origin-Opener-Policy: schema: type: string example: same-origin cf-cache-status: schema: type: string example: DYNAMIC Report-To: schema: type: string example: >- {"group":"cf-nel","max_age":604800,"endpoints":[{"url":"https://a.nel.cloudflare.com/report/v4?s=vG3KwSVEReNI0IWjemXiHoVy6isk0xXhv%2F5rmod%2Fv9WuYoupiCcgYF67Qv8QDkYMvnFYWg8epaHSIIcOk9LuOCAuF%2B70Ib4cPM1aQcf7Ujls9inMz27R%2FtqRfnmojIY%3D"}]} CF-RAY: schema: type: string example: 9b8edb808e8121b3-GDL alt-svc: schema: type: string example: h3=":443"; ma=86400 content: application/json: schema: type: object properties: error: type: object properties: code: type: string message: type: string details: nullable: true transaction_id: type: string example: error: code: INTERNAL_SERVER_ERROR message: >- Lo sentimos hubo un error inesperado, favor de intentar mas tarde. details: null transaction_id: 1840a27f-a181-4839-b3bc-65cc9d4b47d9 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.