Astranexo Receptores API

Clientes guardados de la organización.

Operations 6

GET /recipients Listar receptores #
POST /recipients Crear un receptor #
GET /recipients/lookup Buscar un receptor por identificación #
GET /recipients/{id} Ver un receptor #
PUT /recipients/{id} Reemplazar un receptor #
DELETE /recipients/{id} Eliminar un receptor #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/astranexo-com:astranexo-com-receptores-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

astranexo-com-receptores-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Astranexo Com Receptores API
  version: '1.0'
  contact:
    name: Soporte de Aster
    url: https://astranexo.com/soporte
    email: app@astranexo.com
  description: 'Operations tagged Receptores across 2 of this provider''s published API definitions: aster-openapi.yaml, fe-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://aster.astranexo.com/api/v1
  description: Producción. La misma URL atiende claves de prueba y de producción; la clave decide el ambiente de Hacienda.
security:
- ApiKey: []
tags:
- name: Receptores
  description: Clientes guardados de la organización.
paths:
  /recipients:
    get:
      operationId: listRecipients
      tags:
      - Receptores
      summary: Listar receptores
      description: Clientes guardados de la organización, por nombre, paginados.
      x-required-ability: recipients:read
      parameters:
      - name: search
        in: query
        description: Busca en nombre, identificación y correo.
        schema:
          type: string
      - name: identification_type
        in: query
        description: Tipo de identificación.
        schema:
          $ref: '#/components/schemas/IdentificationType'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Página de receptores.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        data:
                          type: array
                          items:
                            $ref: '#/components/schemas/Recipient'
                        meta:
                          $ref: '#/components/schemas/PaginationMeta'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    post:
      operationId: createRecipient
      tags:
      - Receptores
      summary: Crear un receptor
      description: Guarda un cliente. La identificación no puede repetirse en la organización (`422`).
      x-required-ability: recipients:write
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipientInput'
            example:
              name: María Rodríguez Solís
              identification_type: '01'
              identification_number: '109870654'
              email: maria.rodriguez@example.com
              phone: '88887777'
              province: '2'
              canton: '03'
              district: '01'
              other_address: Residencial Las Palmas, casa 12
      responses:
        '201':
          description: Receptor creado.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
                        name:
                          type: string
                        identification_type:
                          type: string
                        identification_number:
                          type: string
                        created_at:
                          type: string
                          format: date-time
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    servers:
    - url: https://aster.astranexo.com/api/v1
      description: Producción. La misma URL atiende claves de prueba y de producción; la clave decide el ambiente de Hacienda.
  /recipients/lookup:
    get:
      operationId: lookupRecipient
      tags:
      - Receptores
      summary: Buscar un receptor por identificación
      x-required-ability: recipients:read
      description: Devuelve el receptor guardado con esa identificación (`404 recipient_not_found` si no existe).
      parameters:
      - name: identification_number
        in: query
        required: true
        description: Número de identificación (alias `id_number`).
        schema:
          type: string
      - name: identification_type
        in: query
        description: Tipo de identificación.
        schema:
          $ref: '#/components/schemas/IdentificationType'
      responses:
        '200':
          description: El receptor.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/RecipientSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    servers:
    - url: https://aster.astranexo.com/api/v1
      description: Producción. La misma URL atiende claves de prueba y de producción; la clave decide el ambiente de Hacienda.
  /recipients/{id}:
    parameters:
    - name: id
      in: path
      required: true
      description: Id del receptor.
      schema:
        type: integer
        format: int64
    get:
      operationId: getRecipient
      tags:
      - Receptores
      summary: Ver un receptor
      x-required-ability: recipients:read
      description: Un receptor guardado.
      responses:
        '200':
          description: El receptor.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/Recipient'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    put:
      operationId: updateRecipient
      tags:
      - Receptores
      summary: Reemplazar un receptor
      description: 'Reemplaza los datos del receptor. `name`, `identification_type` e

        `identification_number` vacíos conservan el valor actual; los demás campos omitidos

        quedan vacíos.'
      x-required-ability: recipients:write
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipientInput'
      responses:
        '200':
          description: Receptor actualizado.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          type: integer
                          format: int64
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    delete:
      operationId: deleteRecipient
      tags:
      - Receptores
      summary: Eliminar un receptor
      description: Elimina el receptor guardado.
      x-required-ability: recipients:write
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: Receptor eliminado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    servers:
    - url: https://aster.astranexo.com/api/v1
      description: Producción. La misma URL atiende claves de prueba y de producción; la clave decide el ambiente de Hacienda.
components:
  headers:
    X-RateLimit-Reset:
      description: Fin de la ventana actual (segundos Unix).
      schema:
        type: integer
        format: int64
    Retry-After:
      description: Segundos que faltan para poder reintentar.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Solicitudes restantes en la ventana actual.
      schema:
        type: integer
    X-RateLimit-Limit:
      description: Solicitudes permitidas en la ventana actual.
      schema:
        type: integer
  responses:
    Forbidden:
      description: 'Sin permiso: `forbidden` (falta la habilidad), `organization_key_required`, `live_key_required`, `no_tenant`, `tenant_inactive`, `tenant_deleted`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            message: This action is unauthorized.
            error:
              code: forbidden
              message: This action is unauthorized.
            timestamp: '2026-10-08T16:00:00Z'
            api_version: '1.0'
    NotFound:
      description: 'No existe o no pertenece a la organización ni a su ambiente: `not_found` u otro código específico (`xml_not_available`, `response_not_available`, `pdf_not_available`, `no_documents`, `recipient_not_found`, `document_not_found`, `cabys_not_found`, `tariff_not_found`, `province_not_found`).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              code: not_found
              message: Document not found.
            timestamp: '2026-10-08T16:00:00Z'
            api_version: '1.0'
    ValidationFailed:
      description: Validación fallida (`validation_error`, con mensajes por campo en `error.errors`) u otra regla de negocio con su propio código.
      content:
        application/json:
          schema:
            anyOf:
            - $ref: '#/components/schemas/ValidationError'
            - $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              code: validation_error
              message: A valid email is required.
              errors:
                email:
                - A valid email is required.
            timestamp: '2026-10-08T16:00:00Z'
            api_version: '1.0'
    TooManyRequests:
      description: Límite de solicitudes alcanzado (`rate_limited`).
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            message: Rate limit exceeded. Try again in 12 seconds.
            error:
              code: rate_limited
              message: Rate limit exceeded. Try again in 12 seconds.
            timestamp: '2026-10-08T16:00:00Z'
            api_version: '1.0'
    Unauthorized:
      description: 'Clave ausente, desconocida, vencida o revocada: `unauthenticated`, `token_expired`, `key_revoked`, `tenant_unresolved`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            message: Unauthenticated.
            error:
              code: unauthenticated
              message: Unauthenticated.
            timestamp: '2026-10-08T16:00:00Z'
            api_version: '1.0'
    BadRequest:
      description: 'Solicitud mal formada: `invalid_json`, `invalid_request`, `invalid_idempotency_key`, `invalid_body`, `missing_params`, `missing_date`, `invalid_date`, `future_date`, `invalid_currency`, `missing_category`, `missing_param`, `too_many_codes`, etc.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              code: invalid_json
              message: 'Invalid JSON in request body: unexpected EOF'
            timestamp: '2026-10-08T16:00:00Z'
            api_version: '1.0'
  schemas:
    ErrorPayload:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Código estable del error, para usar en el código del cliente.
          example: validation_error
        message:
          type: string
          description: Descripción legible.
        errors:
          type: object
          description: Mensajes por campo (ruta con puntos, por ejemplo `items.0.cabys_code`).
          additionalProperties:
            type: array
            items:
              type: string
    Envelope:
      type: object
      description: Envoltura de las respuestas exitosas.
      required:
      - success
      - timestamp
      - api_version
      properties:
        success:
          type: boolean
          const: true
        message:
          type: string
          description: Mensaje legible (en inglés) de algunas operaciones.
        data:
          description: Contenido de la respuesta.
        timestamp:
          type: string
          format: date-time
        api_version:
          type: string
          example: '1.0'
    Recipient:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        identification_type:
          type: string
        identification_number:
          type: string
        commercial_name:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        fax:
          type:
          - string
          - 'null'
        province:
          type:
          - string
          - 'null'
        canton:
          type:
          - string
          - 'null'
        district:
          type:
          - string
          - 'null'
        neighborhood:
          type:
          - string
          - 'null'
        other_address:
          type:
          - string
          - 'null'
        country_code:
          type:
          - string
          - 'null'
        is_foreign:
          type: boolean
        notes:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
          format: date-time
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
    RecipientInput:
      type: object
      required:
      - name
      - identification_type
      - identification_number
      properties:
        name:
          type: string
        identification_type:
          $ref: '#/components/schemas/IdentificationType'
        identification_number:
          type: string
        commercial_name:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
        fax:
          type: string
        province:
          type: string
        canton:
          type: string
        district:
          type: string
        neighborhood:
          type: string
        other_address:
          type: string
        country_code:
          type: string
        is_foreign:
          type: boolean
        notes:
          type: string
    RecipientSummary:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        identification_type:
          type: string
        identification_number:
          type: string
        email:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
    ErrorEnvelope:
      type: object
      description: Envoltura de los errores.
      required:
      - success
      - error
      - timestamp
      - api_version
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
          description: Repite `error.message` en los errores de autenticación, permisos, límites, idempotencia y cuota.
        error:
          $ref: '#/components/schemas/ErrorPayload'
        timestamp:
          type: string
          format: date-time
        api_version:
          type: string
          example: '1.0'
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
        last_page:
          type: integer
        per_page:
          type: integer
        total:
          type: integer
          format: int64
    IdentificationType:
      type: string
      description: 'Tipo de identificación: `01` física, `02` jurídica, `03` DIMEX, `04` NITE.'
      enum:
      - '01'
      - '02'
      - '03'
      - '04'
    ValidationError:
      description: Error `422 validation_error` con los mensajes por campo.
      allOf:
      - $ref: '#/components/schemas/ErrorEnvelope'
      - type: object
        properties:
          error:
            type: object
            required:
            - code
            - message
            - errors
            properties:
              code:
                type: string
                const: validation_error
              message:
                type: string
                description: Resumen de todos los mensajes, separados por ` | `.
              errors:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
  parameters:
    Page:
      name: page
      in: query
      description: Página (desde 1).
      schema:
        type: integer
        minimum: 1
        default: 1
    PerPage:
      name: per_page
      in: query
      description: Elementos por página (1–100).
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    IdempotencyKey:
      name: X-Idempotency-Key
      in: header
      required: false
      description: Clave única de la operación (máximo 255 caracteres). Repetirla con el mismo cuerpo devuelve la respuesta guardada durante 24 horas.
      schema:
        type: string
        maxLength: 255
        example: 7f3c1e2a-pedido-1042
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: 'Tu llave de API en el encabezado `Authorization: Bearer <llave>`: `aster_test_…` (pruebas) o `aster_live_…` (producción).'
x-refined-from:
- aster-openapi.yaml
- fe-api-openapi.yaml