> ## Documentation Index
> Fetch the complete documentation index at: https://docs.certificados.zapsign.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Lista produtos

> Lista os certificados habilitados para o parceiro.

> [!NOTE]
>
> Veja também: [Erros](https://docs.certificados.zapsign.com.br/erros.md)


## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/partners/protocol-products
openapi: 3.1.0
info:
  title: Certificados ZapSign Partner API v2
  version: 2.0.0
  description: >-
    API REST para parceiros criarem e acompanharem protocolos de certificado
    digital e-CPF e e-CNPJ (A1 e A3 em nuvem), emitidos por videoconferência.
  contact:
    name: Suporte Certificados ZapSign
    url: https://wa.me/5511952135263
servers:
  - url: https://certificados.zapsign.com.br
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Protocolos
    description: Criação, consulta, listagem e cancelamento de protocolos.
  - name: Verificação
    description: Verificação opcional do titular antes de criar o protocolo.
  - name: Agendamento
    description: Horários livres e agendamento da videoconferência.
  - name: Saldo e catálogo
    description: Saldo atual e certificados disponíveis para o parceiro.
paths:
  /api/v2/partners/protocol-products:
    get:
      tags:
        - Saldo e catálogo
      summary: Lista produtos
      description: Lista os certificados habilitados para o parceiro.
      operationId: listProtocolProducts
      responses:
        '200':
          description: >-
            Certificados habilitados para o parceiro. A lista vem vazia se
            nenhum está habilitado.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductList'
              examples:
                e-CPF e e-CNPJ, A1 e A3 em nuvem:
                  summary: e-CPF e e-CNPJ, A1 e A3 em nuvem
                  value:
                    data:
                      - name: e-CPF A1 (1 ano)
                        type: e_cpf
                        model: a1
                        validity_months: 12
                        credits_required: 1
                      - name: e-CPF A3 em nuvem (1 ano)
                        type: e_cpf
                        model: a3_em_nuvem
                        validity_months: 12
                        credits_required: 1
                      - name: e-CNPJ A1 (1 ano)
                        type: e_cnpj
                        model: a1
                        validity_months: 12
                        credits_required: 1
                      - name: e-CNPJ A3 em nuvem (1 ano)
                        type: e_cnpj
                        model: a3_em_nuvem
                        validity_months: 12
                        credits_required: 1
                    has_more: false
                    object: list
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl
            'https://certificados.zapsign.com.br/api/v2/partners/protocol-products'
            \
              -H 'Authorization: Bearer czk_live_SUA_CHAVE'
        - lang: javascript
          label: Node.js (fetch)
          source: >-
            const res = await fetch(
              'https://certificados.zapsign.com.br/api/v2/partners/protocol-products',
              {
                headers: {
                  Authorization: 'Bearer czk_live_SUA_CHAVE',
                },
              },
            );

            const catalogo = await res.json();

            // Cada item de `catalogo.data` é um certificado que você pode usar
            em `certificate`.
        - lang: python
          label: Python (requests)
          source: >-
            import requests


            res = requests.get(
                'https://certificados.zapsign.com.br/api/v2/partners/protocol-products',
                headers={
                    'Authorization': 'Bearer czk_live_SUA_CHAVE',
                },
            )

            catalogo = res.json()

            # Cada item de catalogo['data'] é um certificado que você pode usar
            em certificate.
components:
  headers:
    XRequestId:
      description: Identificador da chamada. Informe-o ao suporte se precisar de ajuda.
      schema:
        type: string
        example: 01K7Q4A1B2C3D4E5F6G7H8J9KM
  schemas:
    ProductList:
      type: object
      required:
        - object
        - has_more
        - data
      properties:
        data:
          type: array
          description: >-
            Certificados habilitados para o parceiro. Para criar um protocolo,
            copie `type`, `model` e `validity_months` de um item para
            `certificate`.
          items:
            $ref: '#/components/schemas/Product'
        has_more:
          type: boolean
          description: 'Sempre `false`: o catálogo vem completo, sem paginação.'
          example: false
        object:
          type: string
          const: list
          description: Sempre `list`.
    Product:
      type: object
      description: Certificado habilitado para o parceiro.
      required:
        - type
        - model
        - validity_months
        - name
        - credits_required
      properties:
        name:
          type: string
          description: Nome do certificado, para exibir ao titular.
          example: e-CPF A1 (1 ano)
        type:
          $ref: '#/components/schemas/CertificateType'
        model:
          $ref: '#/components/schemas/CertificateModel'
        validity_months:
          $ref: '#/components/schemas/ValidityMonths'
        credits_required:
          type: integer
          description: Certificados descontados do saldo por protocolo. Hoje sempre `1`.
          example: 1
    CertificateType:
      type: string
      description: >-
        Tipo do certificado. `e_cpf` é para titular `pf` e `e_cnpj` para titular
        `pj`.


        | Valor | Significado |

        | --- | --- |

        | `e_cpf` | Certificado e-CPF, para titular pessoa física. |

        | `e_cnpj` | Certificado e-CNPJ, para titular pessoa jurídica. |
      enum:
        - e_cpf
        - e_cnpj
    CertificateModel:
      type: string
      description: >-
        Modelo do certificado.


        | Valor | Significado |

        | --- | --- |

        | `a1` | Certificado em arquivo, instalado no computador do titular. |

        | `a3_em_nuvem` | Certificado guardado na nuvem, usado de qualquer
        dispositivo. |
      enum:
        - a1
        - a3_em_nuvem
    ValidityMonths:
      type: integer
      enum:
        - 12
      description: Validade do certificado, em meses. Hoje só `12` (1 ano).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: czk_live_*
      description: >-
        API key criada no [portal do
        parceiro](https://certificados.zapsign.com.br/reseller/api-keys).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.