{"items":[{"type":"link","label":"API pública de parceiros TiqueTaque","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"API pública de parceiros TiqueTaque"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"API pública de parceiros TiqueTaque (1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h2","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Autenticação"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n Para todas as requisições, exceto a geração de token, é necessária a autenticação com um token JWT\n de parceiro, enviado no header "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"seu_token"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":">"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n O token é obtido através do endpoint "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /tokens"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" desta API, utilizando as credenciais\n de um usuário do portal de parceiros. A resposta contém o campo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"token"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" a ser usado\n nas requisições.\n"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h2","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Rate limiting"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n Requisições são limitadas a 60 requisições por janela deslizante de 1 minuto.\n Se o limite for excedido, será retornada uma resposta HTTP "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"429 Too Many Requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"group","label":"Autenticação","link":"/openapi/autenticacao","routeSlug":"/openapi/autenticacao","items":[{"label":"Gera um token de parceiro","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/autenticacao/postpartnertoken","routeSlug":"/openapi/autenticacao/postpartnertoken","metadata":{"seo":{"title":"Gera um token de parceiro","description":"Gera um token JWT de parceiro a partir das credenciais de um usuário do portal de parceiros. O token retornado deve ser enviado no header Authorization: Bearer <token> das demais requisições desta API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnerToken","name":"Gera um token de parceiro","isWebhook":false,"pointer":"/paths/~1tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gera um token de parceiro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gera um token JWT de parceiro a partir das credenciais de um usuário do portal de parceiros. O token retornado deve ser enviado no header "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" das demais requisições desta API."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartnerTokenRequestModel"}},"schemaId":"components/schemas/PartnerTokenRequestModel","pointer":"/paths/~1tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tokens","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PartnerTokenRequestModel"}},"responseCodes":["200","401","422"],"pointer":"/tokens","href":"autenticacao/postpartnertoken","openApiOperationId":"postPartnerToken","summary":"Gera um token de parceiro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"schemaId":"components/schemas/PartnerTokenRequestModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartnerTokenRequestModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token gerado com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerTokenModel"}},"schemaId":"components/schemas/PartnerTokenModel"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais ausentes ou inválidas, ou por usuário ainda não ativado. Usuários do portal de parceiros precisam ativar a conta pelo link recebido por e-mail antes do primeiro login."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/401/content/application~1json/examples/credenciais_invalidas","paths/~1tokens/post/responses/401/content/application~1json/examples/usuario_nao_ativado"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/401/content/application~1json/examples/credenciais_invalidas","paths/~1tokens/post/responses/401/content/application~1json/examples/usuario_nao_ativado"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por corpo da requisição inválido."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/422/content/application~1json/examples/corpo_invalido"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/422/content/application~1json/examples/corpo_invalido"]}],"pointer":"/paths/~1tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PartnerTokenModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerTokenModel"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/401/content/application~1json/examples/credenciais_invalidas","paths/~1tokens/post/responses/401/content/application~1json/examples/usuario_nao_ativado"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/401/content/application~1json/examples/credenciais_invalidas","paths/~1tokens/post/responses/401/content/application~1json/examples/usuario_nao_ativado"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/422/content/application~1json/examples/corpo_invalido"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1tokens/post/responses/422/content/application~1json/examples/corpo_invalido"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autenticacao/postpartnertoken"}],"panels":[]}]},"httpPath":"/tokens"}],"content":{"contentType":"group","meta":{"name":"Autenticação"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Autenticação","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geração de token de acesso à API de parceiros."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tokens","summary":"Gera um token de parceiro","prefix":{"name":"post","color":"post"},"badges":[],"link":"/autenticacao/postpartnertoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Contas","link":"/openapi/contas","routeSlug":"/openapi/contas","items":[{"label":"Lista as contas criadas pelo parceiro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contas/getpartneraccounts","routeSlug":"/openapi/contas/getpartneraccounts","metadata":{"seo":{"title":"Lista as contas criadas pelo parceiro","description":"Retorna a listagem paginada das contas vinculadas ao parceiro identificado pelo token da requisição, ordenadas da mais recente para a mais antiga. Cada conta é retornada com o nome, e-mail financeiro e CNPJ do empregador, o número de funcionários ativos, o número de funcionários contratados na assinatura e o número de reconhecimentos faciais contratados na assinatura ativa. A listagem nunca retorna o token de acesso das contas à API pública TiqueTaque; ele pode ser obtido através do endpoint GET /partner-accounts/{account_id}, mediante a chave secreta da conta."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPartnerAccounts","name":"Lista as contas criadas pelo parceiro","isWebhook":false,"pointer":"/paths/~1partner-accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lista as contas criadas pelo parceiro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna a listagem paginada das contas vinculadas ao parceiro identificado pelo token da requisição, ordenadas da mais recente para a mais antiga. Cada conta é retornada com o nome, e-mail financeiro e CNPJ do empregador, o número de funcionários ativos, o número de funcionários contratados na assinatura e o número de reconhecimentos faciais contratados na assinatura ativa."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A listagem nunca retorna o token de acesso das contas à API pública TiqueTaque; ele pode ser obtido através do endpoint "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /partner-accounts/{account_id}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", mediante a chave secreta da conta."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"max_results","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página de resultados paginados."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados a retornar"},"children":[]}]}]}]}],"pointer":"/paths/~1partner-accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/partner-accounts","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"max_results","in":"query","required":false,"schemaId":"components/schemas/MaxResultsParamModel"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/PageParamModel"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/partner-accounts","href":"contas/getpartneraccounts","openApiOperationId":"getPartnerAccounts","summary":"Lista as contas criadas pelo parceiro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Lista de contas do parceiro.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais ausentes ou inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/401/content/application~1json/examples/401"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por token sem permissão de acesso ao recurso."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/403/content/application~1json/examples/403"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/403/content/application~1json/examples/403"]}],"pointer":"/paths/~1partner-accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/401/content/application~1json/examples/401"]}}},{"code":"403","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/403/content/application~1json/examples/403"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/get/responses/403/content/application~1json/examples/403"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contas/getpartneraccounts"}],"panels":[]}]},"httpPath":"/partner-accounts"},{"label":"Cria uma nova conta vinculada ao parceiro","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contas/postpartneraccount","routeSlug":"/openapi/contas/postpartneraccount","metadata":{"seo":{"title":"Cria uma nova conta vinculada ao parceiro","description":"Cria uma nova conta vinculada ao parceiro identificado pelo token da requisição, aplicando o cupom do parceiro quando este possui um, junto com uma assinatura com a quantidade de funcionários informada em employees_quantity (entre 1 e 5000). São criados os cadastros iniciais da conta: o usuário administrador, o empregador, a unidade e uma escala de trabalho de exemplo. Os e-mails de ativação e boas-vindas são enviados ao usuário administrador quando a assinatura da conta é ativada. A conta é criada com seu token de acesso à API pública TiqueTaque e a chave secreta já gerados, retornados nos campos api_token e secret da resposta. A chave secreta é retornada somente nesta resposta e não pode ser consultada posteriormente."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPartnerAccount","name":"Cria uma nova conta vinculada ao parceiro","isWebhook":false,"pointer":"/paths/~1partner-accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cria uma nova conta vinculada ao parceiro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cria uma nova conta vinculada ao parceiro identificado pelo token da requisição, aplicando o cupom do parceiro quando este possui um, junto com uma assinatura com a quantidade de funcionários informada em "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"employees_quantity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (entre 1 e 5000). São criados os cadastros iniciais da conta: o usuário administrador, o empregador, a unidade e uma escala de trabalho de exemplo. Os e-mails de ativação e boas-vindas são enviados ao usuário administrador quando a assinatura da conta é ativada."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A conta é criada com seu token de acesso à API pública TiqueTaque e a chave secreta já gerados, retornados nos campos "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" e "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" da resposta. A chave secreta é retornada somente nesta resposta e não pode ser consultada posteriormente."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartnerAccountPostModel"}},"schemaId":"components/schemas/PartnerAccountPostModel","pointer":"/paths/~1partner-accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/partner-accounts","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PartnerAccountPostModel"}},"responseCodes":["200","401","403","422"],"pointer":"/partner-accounts","href":"contas/postpartneraccount","openApiOperationId":"postPartnerAccount","summary":"Cria uma nova conta vinculada ao parceiro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"schemaId":"components/schemas/PartnerAccountPostModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PartnerAccountPostModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conta criada com sucesso.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}},"schemaId":"schema_9"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais ausentes ou inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/401/content/application~1json/examples/401"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por token sem permissão de acesso ao recurso."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/403/content/application~1json/examples/403"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/403/content/application~1json/examples/403"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parâmetro obrigatório ausente ou com formato inválido, corpo da requisição inválido, ou e-mail do usuário administrador já cadastrado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/422/content/application~1json/examples/erro_validacao","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/corpo_invalido","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/email_duplicado"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/422/content/application~1json/examples/erro_validacao","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/corpo_invalido","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/email_duplicado"]}],"pointer":"/paths/~1partner-accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/401/content/application~1json/examples/401"]}}},{"code":"403","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/403/content/application~1json/examples/403"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/403/content/application~1json/examples/403"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/422/content/application~1json/examples/erro_validacao","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/corpo_invalido","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/email_duplicado"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts/post/responses/422/content/application~1json/examples/erro_validacao","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/corpo_invalido","paths/~1partner-accounts/post/responses/422/content/application~1json/examples/email_duplicado"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contas/postpartneraccount"}],"panels":[]}]},"httpPath":"/partner-accounts"},{"label":"Retorna uma conta criada pelo parceiro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contas/getpartneraccount","routeSlug":"/openapi/contas/getpartneraccount","metadata":{"seo":{"title":"Retorna uma conta criada pelo parceiro","description":"Retorna uma conta vinculada ao parceiro identificado pelo token da requisição, com os mesmos campos da listagem de contas e o campo api_token. A conta pode ser identificada pelo seu identificador único (campo _id) ou pelo documento do empregador: CNPJ (incluindo o novo formato alfanumérico) ou CPF, sem pontuação. O token de acesso da conta à API pública TiqueTaque (api_token) é retornado somente quando o header X-Secret da requisição corresponde à chave secreta da conta; caso contrário o campo não é retornado. A chave secreta é exibida somente no momento da criação de cada conta."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPartnerAccount","name":"Retorna uma conta criada pelo parceiro","isWebhook":false,"pointer":"/paths/~1partner-accounts~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retorna uma conta criada pelo parceiro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna uma conta vinculada ao parceiro identificado pelo token da requisição, com os mesmos campos da listagem de contas e o campo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A conta pode ser identificada pelo seu identificador único (campo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") ou pelo documento do empregador: CNPJ (incluindo o novo formato alfanumérico) ou CPF, sem pontuação."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" O token de acesso da conta à API pública TiqueTaque ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") é retornado somente quando o header "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X-Secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" da requisição corresponde à chave secreta da conta; caso contrário o campo não é retornado. A chave secreta é exibida somente no momento da criação de cada conta."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_10","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da conta (campo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", 24 caracteres hexadecimais), CNPJ do empregador da conta (14 caracteres sem pontuação: 12 letras ou dígitos mais 2 dígitos verificadores, aceitando o novo formato alfanumérico, com letras maiúsculas ou minúsculas) ou CPF do empregador da conta (11 dígitos, sem pontuação)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Os documentos são procurados somente entre os empregadores das contas do parceiro e seus dígitos verificadores não são validados: um CNPJ ou CPF com formato válido que não corresponda a nenhuma conta do parceiro retorna "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Documentos com pontuação ou qualquer outro formato retornam "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"examples":{"id":{"summary":"Identificador único da conta","value":"5f5bc225b511a6edec2891f7"},"cnpj":{"summary":"CNPJ do empregador","value":"23467093000164"},"cnpj_alfanumerico":{"summary":"CNPJ alfanumérico do empregador","value":"12ABC34501DE35"},"cpf":{"summary":"CPF do empregador","value":"01234567890"}}}],"pointer":"/paths/~1partner-accounts~1{account_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Secret","in":"header","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chave secreta da conta (campo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retornado na criação da conta). Quando presente e correspondente à chave secreta da conta, o campo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é retornado com o token de acesso à API pública."},"children":[]}]}]}]}],"pointer":"/paths/~1partner-accounts~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/partner-accounts/{account_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"example":"5f5bc225b511a6edec2891f7","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[{"name":"X-Secret","in":"header","required":false,"schemaId":"schema_11"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/partner-accounts/{account_id}","href":"contas/getpartneraccount","openApiOperationId":"getPartnerAccount","summary":"Retorna uma conta criada pelo parceiro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conta do parceiro.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerAccountDetailModel"}},"schemaId":"components/schemas/PartnerAccountDetailModel"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por credenciais ausentes ou inválidas."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/401/content/application~1json/examples/401"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/401/content/application~1json/examples/401"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por token sem permissão de acesso ao recurso."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/403/content/application~1json/examples/403"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/403/content/application~1json/examples/403"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por conta inexistente, não vinculada ao parceiro ou sem empregador com o CNPJ ou CPF informado."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/404/content/application~1json/examples/404"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/404/content/application~1json/examples/404"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Erro por identificador com formato inválido: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deve ser o identificador único da conta (24 caracteres hexadecimais), o CNPJ do empregador (14 caracteres, sem pontuação) ou o CPF do empregador (11 dígitos, sem pontuação). Documentos enviados com pontuação também retornam este erro."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/422/content/application~1json/examples/identificador_invalido"]}},"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/422/content/application~1json/examples/identificador_invalido"]}],"pointer":"/paths/~1partner-accounts~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PartnerAccountDetailModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerAccountDetailModel"}}},{"code":"401","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/401/content/application~1json/examples/401"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/401/content/application~1json/examples/401"]}}},{"code":"403","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/403/content/application~1json/examples/403"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/403/content/application~1json/examples/403"]}}},{"code":"404","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/404/content/application~1json/examples/404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/404/content/application~1json/examples/404"]}}},{"code":"422","schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/422/content/application~1json/examples/identificador_invalido"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroRespostaModel","exampleIds":["paths/~1partner-accounts~1{account_id}/get/responses/422/content/application~1json/examples/identificador_invalido"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contas/getpartneraccount"}],"panels":[]}]},"httpPath":"/partner-accounts/{account_id}"}],"content":{"contentType":"group","meta":{"name":"Contas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contas","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operações sobre as contas criadas pelo parceiro."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/partner-accounts","summary":"Lista as contas criadas pelo parceiro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contas/getpartneraccounts","deprecated":false},{"title":"/partner-accounts","summary":"Cria uma nova conta vinculada ao parceiro","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contas/postpartneraccount","deprecated":false},{"title":"/partner-accounts/{account_id}","summary":"Retorna uma conta criada pelo parceiro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contas/getpartneraccount","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/IsoDateTimeTzModel":{"id":"components/schemas/IsoDateTimeTzModel","kind":"json-schema","title":"IsoDateTimeTzModel","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[+-][0-2]\\d:[0-5]\\d$","example":"2026-01-01T00:00:00+00:00"}},"components/schemas/PartnerAccountModel":{"id":"components/schemas/PartnerAccountModel","kind":"json-schema","title":"PartnerAccountModel","data":{"type":"object","properties":{"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da conta, gerado internamente."},"children":[]}]}]}],"type":"string","example":"5f5bc225b511a6edec2891f7"},"_created":{"$ref":"#/components/schemas/IsoDateTimeTzModel"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome do empregador vinculado à conta."},"children":[]}]}]}],"type":"string","nullable":true,"example":"TIQUETAQUE SERVICOS DE TECNOLOGIA S.A."},"financial_email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-mail do setor financeiro do empregador vinculado à conta."},"children":[]}]}]}],"type":"string","nullable":true,"example":"financeiro@empresa.com"},"cnpj":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNPJ do empregador vinculado à conta. Apenas números."},"children":[]}]}]}],"type":"string","nullable":true,"example":"23467093000164"},"active_employees":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de funcionários ativos da conta."},"children":[]}]}]}],"type":"integer","example":12},"subscription_employees":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de funcionários contratados nas assinaturas da conta."},"children":[]}]}]}],"type":"integer","example":15},"subscription_face_ids":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de reconhecimentos faciais contratados na assinatura ativa da conta."},"children":[]}]}]}],"type":"integer","example":5}}}},"components/schemas/PartnerAccountDetailModel":{"id":"components/schemas/PartnerAccountDetailModel","kind":"json-schema","title":"PartnerAccountDetailModel","data":{"allOf":[{"$ref":"#/components/schemas/PartnerAccountModel"},{"type":"object","properties":{"api_token":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de acesso da conta à API pública TiqueTaque (usado com autenticação BasicAuth sendo user=public, senha=<api_token>). Presente somente quando o header "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X-Secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" da requisição corresponde à chave secreta da conta (campo "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retornado na criação da conta); caso o header esteja ausente ou não corresponda, o campo não é retornado. Retorna null caso o token tenha sido revogado."},"children":[]}]}]}],"type":"string","nullable":true,"example":"8f14e45fceea167a5a36dedd4bea2543"}}}]}},"components/schemas/PartnerTokenRequestModel":{"id":"components/schemas/PartnerTokenRequestModel","kind":"json-schema","title":"PartnerTokenRequestModel","data":{"type":"object","required":["email","password"],"properties":{"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-mail do usuário do portal de parceiros."},"children":[]}]}]}],"type":"string","example":"parceiro@empresa.com"},"password":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Senha do usuário do portal de parceiros."},"children":[]}]}]}],"type":"string"}}}},"components/schemas/PartnerTokenModel":{"id":"components/schemas/PartnerTokenModel","kind":"json-schema","title":"PartnerTokenModel","data":{"type":"object","properties":{"token":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token JWT de parceiro a ser usado no header Authorization das demais requisições."},"children":[]}]}]}],"type":"string"},"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do usuário do portal de parceiros autenticado."},"children":[]}]}]}],"type":"string","example":"5f5bc225b511a6edec2891f7"}}}},"components/schemas/PartnerAccountPostModel":{"id":"components/schemas/PartnerAccountPostModel","kind":"json-schema","title":"PartnerAccountPostModel","data":{"type":"object","required":["full_name","email","mobile_phone","company_doc","employees_quantity"],"properties":{"full_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome completo do usuário administrador da nova conta."},"children":[]}]}]}],"type":"string","maxLength":200,"example":"Exemplo da Silva"},"employees_quantity":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade de funcionários da assinatura da nova conta. Deve ser entre 1 e 5000."},"children":[]}]}]}],"type":"integer","minimum":1,"maximum":5000,"example":10},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-mail do usuário administrador da nova conta. Recebe os e-mails de ativação e boas-vindas."},"children":[]}]}]}],"type":"string","example":"exemplo@empresa.com"},"mobile_phone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de telefone celular com código de área, somente números."},"children":[]}]}]}],"type":"string","example":"11991234567"},"company_doc":{"type":"object","required":["name","trade_name","address"],"properties":{"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Razão social do empregador."},"children":[]}]}]}],"type":"string","example":"TIQUETAQUE SERVICOS DE TECNOLOGIA S.A."},"trade_name":{"description":"Nome fantasia do empregador.","type":"string","example":"TiqueTaque"},"cpf":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPF do empregador. Apenas números. Necessário que exista ou este campo ou o campo CNPJ, mutuamente exclusivos."},"children":[]}]}]}],"type":"string","pattern":"^\\d{11}$","example":"01234567890"},"cnpj":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CNPJ do empregador. Apenas números. Necessário que exista ou este campo ou o campo CPF, mutuamente exclusivos."},"children":[]}]}]}],"type":"string","pattern":"^[0-9A-Z]{12}\\d{2}$","example":"23467093000164"},"financial_email":{"description":"E-mail do setor financeiro do empregador.","type":"string","example":"financeiro@empresa.com"},"address":{"type":"object","required":["cep","street_name","street_number","neighborhood","state","city"],"properties":{"cep":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CEP do endereço do empregador. Apenas números."},"children":[]}]}]}],"type":"string","example":"90240111"},"street_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logradouro do endereço."},"children":[]}]}]}],"type":"string","example":"RUA FREDERICO MENTZ"},"street_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do endereço."},"children":[]}]}]}],"type":"string","maxLength":6,"example":"1606"},"neighborhood":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bairro do endereço."},"children":[]}]}]}],"type":"string","example":"Navegantes"},"complement":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complemento do endereço, caso exista."},"children":[]}]}]}],"type":"string","example":"LOJA 134"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UF do endereço."},"children":[]}]}]}],"type":"string","example":"RS"},"city":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cidade do endereço do empregador."},"children":[]}]}]}],"type":"string","example":"Porto Alegre"}}}}}}}},"components/schemas/LinksModel":{"id":"components/schemas/LinksModel","kind":"json-schema","title":"LinksModel","data":{"type":"object","properties":{"parent":{"type":"object","properties":{"href":{"type":"string"},"title":{"type":"string"}}},"self":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página atual. Presente apenas quando existem resultados."},"children":[]}]}]}],"type":"object","properties":{"href":{"type":"string"},"title":{"type":"string"}}},"next":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Próxima página. Presente apenas quando existe uma página seguinte."},"children":[]}]}]}],"type":"object","properties":{"href":{"type":"string"},"title":{"type":"string"}}},"last":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Última página. Presente apenas quando existe mais de uma página."},"children":[]}]}]}],"type":"object","properties":{"href":{"type":"string"},"title":{"type":"string"}}}}}},"components/schemas/MetaModel":{"id":"components/schemas/MetaModel","kind":"json-schema","title":"MetaModel","data":{"type":"object","properties":{"max_results":{"type":"integer"},"page":{"type":"integer"},"total":{"type":"integer"}}}},"components/schemas/MaxResultsParamModel":{"id":"components/schemas/MaxResultsParamModel","kind":"json-schema","title":"MaxResultsParamModel","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página dos resultados, valor padrão 25."},"children":[]}]}]}],"default":25}},"components/schemas/PageParamModel":{"id":"components/schemas/PageParamModel","kind":"json-schema","title":"PageParamModel","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página de resultados solicitada."},"children":[]}]}]}],"default":1}},"components/schemas/ErroRespostaModel":{"id":"components/schemas/ErroRespostaModel","kind":"json-schema","title":"ErroRespostaModel","data":{"description":"Resposta de erro","type":"object","properties":{"_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de erro interno. Ausente nos erros de validação de campos, nos quais "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"_error.message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contém um objeto com os erros por campo."},"children":[]}]}]}],"type":"integer"},"_status":{"type":"string","example":"ERR"},"_error":{"type":"object","properties":{"code":{"description":"Codigo de erro HTTP.","type":"integer"},"message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mensagem de erro interna. Nos erros de validação de campos (veja "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"_code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), é um objeto que mapeia cada campo inválido à lista de mensagens de erro daquele campo."},"children":[]}]}]}],"oneOf":[{"type":"string"},{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}]},"ui_message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mensagem de erro para o usuário."},"children":[]}]}]}],"type":"string"}}}}}},"schema_6":{"kind":"json-schema","data":{"$ref":"#/components/schemas/MaxResultsParamModel"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PageParamModel"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"object","properties":{"_items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerAccountModel"}},"_links":{"$ref":"#/components/schemas/LinksModel"},"_meta":{"$ref":"#/components/schemas/MetaModel"}}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da nova conta."},"children":[]}]}]}],"type":"string","example":"5f5bc225b511a6edec2891f7"},"api_token":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de acesso da nova conta à API pública TiqueTaque (usado com autenticação BasicAuth sendo user=public, senha=<api_token>), gerado automaticamente na criação da conta."},"children":[]}]}]}],"type":"string","nullable":true,"example":"e7a56a3e-8a5b-4a75-b7a4-4bfbe6f36a10"},"secret":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chave secreta da nova conta, gerada automaticamente na criação. Retornada somente nesta resposta, não sendo possível consultá-la posteriormente."},"children":[]}]}]}],"type":"string","nullable":true,"example":"kHc9tGm3xQ7LpZ2vNwRbQg"}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","pattern":"^([0-9a-fA-F]{24}|[0-9A-Za-z]{12}[0-9]{2}|[0-9]{11})$"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string"},"id":"schema_11"}},"exampleStore":{"components/examples/401_example":{"id":"components/examples/401_example","value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"}},"components/examples/403_example":{"id":"components/examples/403_example","value":{"_code":666,"_error":{"code":403,"message":"Forbidden resource for this token.","ui_message":"Acesso não autorizado."},"_status":"ERR"}},"components/examples/404_account_example":{"id":"components/examples/404_account_example","value":{"_code":56,"_error":{"code":404,"message":"account not found.","ui_message":"account não encontrado."},"_status":"ERR"}},"components/examples/422_validation_example":{"id":"components/examples/422_validation_example","value":{"_error":{"code":422,"message":{"company_doc":["required field"]}},"_status":"ERR"},"summary":"Erro de validação de campos"},"components/examples/422_invalid_account_id_example":{"id":"components/examples/422_invalid_account_id_example","value":{"_code":113,"_error":{"code":422,"message":"Invalid 'account_id' query parameter for request.","ui_message":"Parâmetro account_id inválido para essa requisição."},"_status":"ERR"},"summary":"Identificador da conta com formato inválido"},"components/examples/422_invalid_body_example":{"id":"components/examples/422_invalid_body_example","value":{"_code":1405,"_error":{"code":422,"message":"Invalid body format.","ui_message":"Formato do corpo da requisição inválido."},"_status":"ERR"},"summary":"Corpo da requisição não é um JSON válido"},"components/examples/422_duplicated_email_example":{"id":"components/examples/422_duplicated_email_example","value":{"_code":88,"_error":{"code":422,"message":"Value is not unique","ui_message":"Valor já cadastrado no sistema."},"_status":"ERR"},"summary":"E-mail já cadastrado"},"paths/~1tokens/post/responses/401/content/application~1json/examples/credenciais_invalidas":{"value":{"_code":1418,"_error":{"code":401,"message":"Invalid credentials.","ui_message":"Credenciais inválidas."},"_status":"ERR"},"key":"credenciais_invalidas","summary":"Credenciais ausentes ou inválidas","id":"paths/~1tokens/post/responses/401/content/application~1json/examples/credenciais_invalidas"},"paths/~1tokens/post/responses/401/content/application~1json/examples/usuario_nao_ativado":{"value":{"_code":24,"_error":{"code":401,"message":"Account not activated. Verify email.","ui_message":"Conta ainda não ativada, verifique o e-mail de ativação."},"_status":"ERR"},"key":"usuario_nao_ativado","summary":"Usuário ainda não ativado","id":"paths/~1tokens/post/responses/401/content/application~1json/examples/usuario_nao_ativado"},"paths/~1tokens/post/responses/422/content/application~1json/examples/corpo_invalido":{"value":{"_code":1405,"_error":{"code":422,"message":"Invalid body format.","ui_message":"Formato do corpo da requisição inválido."},"_status":"ERR"},"key":"corpo_invalido","summary":"Corpo da requisição não é um JSON válido","id":"paths/~1tokens/post/responses/422/content/application~1json/examples/corpo_invalido"},"paths/~1partner-accounts/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1partner-accounts/get/responses/401/content/application~1json/examples/401"},"paths/~1partner-accounts/get/responses/403/content/application~1json/examples/403":{"value":{"_code":666,"_error":{"code":403,"message":"Forbidden resource for this token.","ui_message":"Acesso não autorizado."},"_status":"ERR"},"key":"403","summary":"403","id":"paths/~1partner-accounts/get/responses/403/content/application~1json/examples/403"},"paths/~1partner-accounts/post/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1partner-accounts/post/responses/401/content/application~1json/examples/401"},"paths/~1partner-accounts/post/responses/403/content/application~1json/examples/403":{"value":{"_code":666,"_error":{"code":403,"message":"Forbidden resource for this token.","ui_message":"Acesso não autorizado."},"_status":"ERR"},"key":"403","summary":"403","id":"paths/~1partner-accounts/post/responses/403/content/application~1json/examples/403"},"paths/~1partner-accounts/post/responses/422/content/application~1json/examples/erro_validacao":{"value":{"_error":{"code":422,"message":{"company_doc":["required field"]}},"_status":"ERR"},"key":"erro_validacao","summary":"Erro de validação de campos","id":"paths/~1partner-accounts/post/responses/422/content/application~1json/examples/erro_validacao"},"paths/~1partner-accounts/post/responses/422/content/application~1json/examples/corpo_invalido":{"value":{"_code":1405,"_error":{"code":422,"message":"Invalid body format.","ui_message":"Formato do corpo da requisição inválido."},"_status":"ERR"},"key":"corpo_invalido","summary":"Corpo da requisição não é um JSON válido","id":"paths/~1partner-accounts/post/responses/422/content/application~1json/examples/corpo_invalido"},"paths/~1partner-accounts/post/responses/422/content/application~1json/examples/email_duplicado":{"value":{"_code":88,"_error":{"code":422,"message":"Value is not unique","ui_message":"Valor já cadastrado no sistema."},"_status":"ERR"},"key":"email_duplicado","summary":"E-mail já cadastrado","id":"paths/~1partner-accounts/post/responses/422/content/application~1json/examples/email_duplicado"},"paths/~1partner-accounts~1{account_id}/get/responses/401/content/application~1json/examples/401":{"value":{"_code":9,"_error":{"code":401,"message":"Invalid account credentials.","ui_message":"Credenciais inválidas"},"_status":"ERR"},"key":"401","summary":"401","id":"paths/~1partner-accounts~1{account_id}/get/responses/401/content/application~1json/examples/401"},"paths/~1partner-accounts~1{account_id}/get/responses/403/content/application~1json/examples/403":{"value":{"_code":666,"_error":{"code":403,"message":"Forbidden resource for this token.","ui_message":"Acesso não autorizado."},"_status":"ERR"},"key":"403","summary":"403","id":"paths/~1partner-accounts~1{account_id}/get/responses/403/content/application~1json/examples/403"},"paths/~1partner-accounts~1{account_id}/get/responses/404/content/application~1json/examples/404":{"value":{"_code":56,"_error":{"code":404,"message":"account not found.","ui_message":"account não encontrado."},"_status":"ERR"},"key":"404","summary":"404","id":"paths/~1partner-accounts~1{account_id}/get/responses/404/content/application~1json/examples/404"},"paths/~1partner-accounts~1{account_id}/get/responses/422/content/application~1json/examples/identificador_invalido":{"value":{"_code":113,"_error":{"code":422,"message":"Invalid 'account_id' query parameter for request.","ui_message":"Parâmetro account_id inválido para essa requisição."},"_status":"ERR"},"key":"identificador_invalido","summary":"Identificador da conta com formato inválido","id":"paths/~1partner-accounts~1{account_id}/get/responses/422/content/application~1json/examples/identificador_invalido"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.tiquetaque.com/partners/v1","description":"Production"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"API pública de parceiros TiqueTaque","description":"

Autenticação

\n Para todas as requisições, exceto a geração de token, é necessária a autenticação com um token JWT\n de parceiro, enviado no header Authorization: Bearer <seu_token>.
\n O token é obtido através do endpoint POST /tokens desta API, utilizando as credenciais\n de um usuário do portal de parceiros. A resposta contém o campo token a ser usado\n nas requisições.\n

Rate limiting

\n Requisições são limitadas a 60 requisições por janela deslizante de 1 minuto.\n Se o limite for excedido, será retornada uma resposta HTTP 429 Too Many Requests.
\n"}},"baseSlug":"/openapi","routesMapping":{}}