Migo API REST · v1

    API de Migo

    Conecta tus sistemas con la facturación electrónica, los clientes, los productos, la caja y el módulo de restaurante de Migo. Empieza en tres pasos y luego explora la referencia completa.

    Ver documentación de la API → Inicio rápido
    • OAuth 2client_credentials
    • JSONsobre HTTPS
    • Permisospor rol
    Cada petición
    GET /api/v1/customers
    Authorization: Bearer eyJhbGciOiJSUzI1NiIs…
    
    200 OK
    {
      "data": [ … ],
      "pagination": { "totalElements": 128 }
    }
    Inicio rápido

    De cero a tu primera llamada

    La API usa OAuth 2 con el flujo client_credentials: cambias tus credenciales por un token de acceso y lo envías en cada petición.

    1. 1

      Obtén tus credenciales de API

      Inicia sesión en el sistema principal de Migo ↗ y abre:

      Seguridad›Credenciales API

      Ahí creas una credencial y obtienes su client_id y su client_secret. La credencial trabaja con el rol que le asignes: sus permisos definen qué endpoints puede usar.

      Guarda el client_secret como una contraseña. No lo publiques en el código de una app ni en un repositorio; úsalo solo desde tu servidor.
      Ir al sistema de Migo sistema.migo.com.ec ↗
    2. 2

      Pide un token de acceso

      Envía un POST a /oauth2/token con grant_type=client_credentials en el cuerpo, como formulario (application/x-www-form-urlencoded). Tus credenciales pueden ir de dos formas; usa la que prefieras:

      • Opción 1: autenticación Basic. En el encabezado Authorization: el usuario es tu client_id y la contraseña tu client_secret.
      • Opción 2: en el cuerpo. Envía client_id y client_secret como campos del mismo formulario, junto a grant_type.
      • Dura 1 hora. No hay refresh token: cuando expire, o si una llamada responde 401, pide uno nuevo.
      • Reutilízalo. Cada credencial puede emitir hasta 10 tokens por hora; pasado ese límite la respuesta es 429.
      curl -X POST https://api.migo.com.ec/oauth2/token \
        -u "TU_CLIENT_ID:TU_CLIENT_SECRET" \
        -H "Content-Type: application/x-www-form-urlencoded" \
        -d "grant_type=client_credentials"
      const credentials = btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
      
      const response = await fetch("https://api.migo.com.ec/oauth2/token", {
        method: "POST",
        headers: {
          Authorization: `Basic ${credentials}`,
          "Content-Type": "application/x-www-form-urlencoded",
        },
        body: "grant_type=client_credentials",
      });
      
      const { access_token } = await response.json();
      import requests
      
      response = requests.post(
          "https://api.migo.com.ec/oauth2/token",
          auth=(CLIENT_ID, CLIENT_SECRET),
          data={"grant_type": "client_credentials"},
      )
      access_token = response.json()["access_token"]
      String credentials = Base64.getEncoder().encodeToString(
              (clientId + ":" + clientSecret).getBytes(StandardCharsets.UTF_8));
      
      HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.migo.com.ec/oauth2/token"))
              .header("Authorization", "Basic " + credentials)
              .header("Content-Type", "application/x-www-form-urlencoded")
              .POST(HttpRequest.BodyPublishers.ofString("grant_type=client_credentials"))
              .build();
      
      HttpResponse<String> response = HttpClient.newHttpClient()
              .send(request, HttpResponse.BodyHandlers.ofString());
      curl -X POST https://api.migo.com.ec/oauth2/token \
        -H "Content-Type: application/x-www-form-urlencoded" \
        -d "grant_type=client_credentials" \
        -d "client_id=TU_CLIENT_ID" \
        -d "client_secret=TU_CLIENT_SECRET"
      const response = await fetch("https://api.migo.com.ec/oauth2/token", {
        method: "POST",
        body: new URLSearchParams({
          grant_type: "client_credentials",
          client_id: CLIENT_ID,
          client_secret: CLIENT_SECRET,
        }),
      });
      
      const { access_token } = await response.json();
      import requests
      
      response = requests.post(
          "https://api.migo.com.ec/oauth2/token",
          data={
              "grant_type": "client_credentials",
              "client_id": CLIENT_ID,
              "client_secret": CLIENT_SECRET,
          },
      )
      access_token = response.json()["access_token"]
      String form = "grant_type=client_credentials"
              + "&client_id=" + URLEncoder.encode(clientId, StandardCharsets.UTF_8)
              + "&client_secret=" + URLEncoder.encode(clientSecret, StandardCharsets.UTF_8);
      
      HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.migo.com.ec/oauth2/token"))
              .header("Content-Type", "application/x-www-form-urlencoded")
              .POST(HttpRequest.BodyPublishers.ofString(form))
              .build();
      
      HttpResponse<String> response = HttpClient.newHttpClient()
              .send(request, HttpResponse.BodyHandlers.ofString());
      Respuesta 200 OK
      {
        "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6…",
        "token_type": "Bearer",
        "expires_in": 3599
      }
    3. 3

      Llama a los endpoints

      Agrega este encabezado a todas las peticiones de la documentación:

      Authorization: Bearer <access_token>

      La empresa se toma del token, así que ningún endpoint la pide como parámetro.

      Pruébalo en la documentación →
      Ejemplo
      curl "https://api.migo.com.ec/api/v1/customers?page=0&size=10" \
        -H "Authorization: Bearer $ACCESS_TOKEN"
      const response = await fetch(
        "https://api.migo.com.ec/api/v1/customers?page=0&size=10",
        { headers: { Authorization: `Bearer ${accessToken}` } },
      );
      
      const { data, pagination } = await response.json();
      response = requests.get(
          "https://api.migo.com.ec/api/v1/customers",
          params={"page": 0, "size": 10},
          headers={"Authorization": f"Bearer {access_token}"},
      )
      customers = response.json()["data"]
      HttpRequest request = HttpRequest.newBuilder(
                      URI.create("https://api.migo.com.ec/api/v1/customers?page=0&size=10"))
              .header("Authorization", "Bearer " + accessToken)
              .GET()
              .build();
      
      HttpResponse<String> response = HttpClient.newHttpClient()
              .send(request, HttpResponse.BodyHandlers.ofString());
    Respuestas de error

    Qué significa cada error

    401

    Token ausente, vencido o inválido

    Pide un token nuevo. Si viene de /oauth2/token con invalid_client, revisa el client_id y el client_secret.

    403

    Sin permiso

    El rol de la credencial no tiene el permiso que indica el endpoint en su descripción, como CUSTOMER:CREATE.

    400 / 422

    Datos inválidos o regla de negocio

    El cuerpo trae el detalle en message y, por campo, en errors.

    429

    Demasiadas solicitudes de token

    Superaste el límite de emisión. Reutiliza el token vigente hasta que expire.

    Ya tienes tu token

    Explora todos los endpoints con sus parámetros, ejemplos y respuestas, y pruébalos desde el navegador.

    Ver documentación de la API →