A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.
Bem-vindo à documentação da API da Salvy! Esta API foi projetada para oferecer uma interface eficiente, segura e robusta para acessar e interagir com os serviços da Salvy. Aqui você encontrará todas as informações necessárias para integrar-se à nossa plataforma e começar a construir soluções incríveis.
Todas as requisições à API devem ser feitas para o seguinte endereço base:
https://api.salvy.com.br
Certifique-se de usar HTTPS em todas as suas requisições para garantir a segurança da comunicação.A Salvy oferece os ambientes de produção e sandbox, ambos neste mesmo endereço base. O ambiente é definido pela chave de API utilizada. Saiba mais em Ambientes.
Para cada requisição o método de autenticação é baseado em Bearer Token para garantir acesso seguro aos seus recursos. Para cada requisição à API, é necessário incluir um token de autenticação válido no cabeçalho HTTP Authorization.
Você pode criar e gerenciar suas chaves de API diretamente no dashboard, na página de API & Webhooks. Consulte o guia de Chaves de API para mais detalhes.
A chave é exibida apenas uma vez. Copie e guarde-a em um local seguro antes de
fechar a janela.
Se o token não for fornecido ou for inválido, a API retornará um erro com o código de status HTTP 401 Unauthorized. Verifique se:
O token está correto.
O token não expirou.
O cabeçalho Authorization segue o formato especificado.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Salvy API","colors":{"primary":"#141414","light":"#F4F2EE","dark":"#141414"},"logo":{"light":"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/logo/light.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=7178c70a1bd802f95c5ee9f7b1db46eb","dark":"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/logo/dark.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=051c12a119e79f1642976a34164ff8a6"},"favicon":"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/favicon.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=f26d50e69740ed3a04896d820cac4e7f","navbar":{"links":[{"href":"https://wa.me/551151963488","label":"Suporte"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.salvy.com.br"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/use-salvy"}},"contextual":{"options":["copy","download-spec","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"salvy-88fe5c1a","hasAudioNarration":false,"actualSubdomain":"salvy-88fe5c1a","customDomains":["docs.salvy.com.br"],"gitSource":{"type":"github","owner":"salvyltd","repo":"salvy-public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aedcda225df1b8f9bf5bbf4","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Referência API","count":145},{"language":"default","tag":"Webhooks","count":26},{"language":"default","tag":"Equipamentos","count":20},{"language":"default","tag":"Documentação","count":19},{"language":"default","tag":"Linhas","count":17},{"language":"default","tag":"Números virtuais","count":15},{"language":"default","tag":"MCP","count":14},{"language":"default","tag":"Colaboradores","count":11},{"language":"default","tag":"Faturas","count":6},{"language":"default","tag":"Receitas","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/introduction","slug":"/api-reference/v2/introduction","pageMetadata":{"title":"Introdução","description":"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.","href":"/api-reference/v2/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Bem-vindo à documentação da API da Salvy! Esta API foi projetada para oferecer uma interface eficiente, segura e robusta para acessar e interagir com os serviços da Salvy. Aqui você encontrará todas as informações necessárias para integrar-se à nossa plataforma e começar a construir soluções incríveis.`}),`\n`,_jsx(Heading,{level:`2`,id:`endereço-base-da-api`,children:`Endereço Base da API`}),`\n`,_jsx(_components.p,{children:`Todas as requisições à API devem ser feitas para o seguinte endereço base:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.salvy.com.br`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`Certifique-se de usar HTTPS em todas as suas requisições para garantir a segurança da comunicação.`}),`\n`,_jsxs(_components.p,{children:[`A Salvy oferece os ambientes de produção e sandbox, ambos neste mesmo endereço base. O ambiente é definido pela chave de API utilizada. Saiba mais em `,_jsx(_components.a,{href:`/api-reference/v2/environments`,children:`Ambientes`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`autenticação`,children:`Autenticação`}),`\n`,_jsxs(_components.p,{children:[`Para cada requisição o método de autenticação é baseado em `,_jsx(_components.strong,{children:`Bearer Token`}),` para garantir acesso seguro aos seus recursos. Para cada requisição à API, é necessário incluir um token de autenticação válido no cabeçalho HTTP `,_jsx(_components.code,{children:`Authorization`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`como-obter-seu-token`,children:`Como obter seu token`}),`\n`,_jsxs(_components.p,{children:[`Você pode criar e gerenciar suas chaves de API diretamente no dashboard, na página de `,_jsx(_components.a,{href:`https://app.salvy.com.br/settings/api`,children:`API \u0026 Webhooks`}),`. Consulte o guia de `,_jsx(_components.a,{href:`/api-reference/v2/api-keys`,children:`Chaves de API`}),` para mais detalhes.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`A chave é exibida apenas uma vez. Copie e guarde-a em um local seguro antes de\nfechar a janela.`})}),`\n`,_jsx(Heading,{level:`3`,id:`formato-do-cabeçalho`,children:`Formato do Cabeçalho`}),`\n`,_jsx(_components.p,{children:`O token deve ser enviado no seguinte formato:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Authorization: Bearer \u003cseu_token>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Substitua `,_jsx(_components.code,{children:`\u003cseu_token>`}),` pelo token fornecido pela Salvy.`]}),`\n`,_jsxs(_components.li,{children:[`O prefixo `,_jsx(_components.code,{children:`Bearer`}),` é obrigatório e deve ser seguido por um espaço antes do token.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`exemplo-de-requisição`,children:`Exemplo de Requisição`}),`\n`,_jsxs(_components.p,{children:[`Aqui está um exemplo de requisição usando `,_jsx(_components.code,{children:`curl`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.salvy.com.br/resource\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization: Bearer salvy_test_abc123def456gh789\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`erros-de-autenticação`,children:`Erros de Autenticação`}),`\n`,_jsxs(_components.p,{children:[`Se o token não for fornecido ou for inválido, a API retornará um erro com o código de status `,_jsx(_components.code,{children:`HTTP 401 Unauthorized`}),`. Verifique se:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`O token está correto.`}),`\n`,_jsx(_components.li,{children:`O token não expirou.`}),`\n`,_jsx(_components.li,{children:`O cabeçalho Authorization segue o formato especificado.`}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introdução","description":"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.","href":"/api-reference/v2/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endereço Base da API","slug":"endereço-base-da-api","depth":2,"children":[]},{"title":"Autenticação","slug":"autenticação","depth":2,"children":[{"title":"Como obter seu token","slug":"como-obter-seu-token","depth":3,"children":[]},{"title":"Formato do Cabeçalho","slug":"formato-do-cabeçalho","depth":3,"children":[]},{"title":"Exemplo de Requisição","slug":"exemplo-de-requisição","depth":3,"children":[]},{"title":"Erros de Autenticação","slug":"erros-de-autenticação","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"salvy-88fe5c1a","siteName":"Salvy API","title":"Introdução - Salvy API","navMaps":{"firstHrefInVersion":{"v3":{"href":"/api-reference/v3/introduction","matchLevel":1},"v2":{"href":"/api-reference/v2/introduction","matchLevel":0},"v1":{"href":"/api-reference/v1/introduction","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-08-07T21:15:26.612Z","originalFileLocation":"api-reference/v2/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Salvy API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introdução - Salvy API\">\u003cmeta data-mint-head property=\"og:description\" content=\"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Salvy API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.salvy.com.br/api-reference/v2/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://salvy-88fe5c1a.mintlify.site/_mintlify/api/og/v2?division=Documenta%C3%A7%C3%A3o\u0026amp;title=Introdu%C3%A7%C3%A3o\u0026amp;description=A+API+da+Salvy+permite+integrar+seus+sistemas+aos+produtos+da+plataforma.+Nesta+documenta%C3%A7%C3%A3o+voc%C3%AA+encontrar%C3%A1+tudo+o+que+precisa+para+autenticar+suas+requisi%C3%A7%C3%B5es\u0026amp;theme=9e9623747e20268e9ce176d1\u0026amp;signature=72f1985776047d593975e86ff301ae8085553b305ab4da4711fd19d7661ce0de\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introdução - Salvy API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://salvy-88fe5c1a.mintlify.site/_mintlify/api/og/v2?division=Documenta%C3%A7%C3%A3o\u0026amp;title=Introdu%C3%A7%C3%A3o\u0026amp;description=A+API+da+Salvy+permite+integrar+seus+sistemas+aos+produtos+da+plataforma.+Nesta+documenta%C3%A7%C3%A3o+voc%C3%AA+encontrar%C3%A1+tudo+o+que+precisa+para+autenticar+suas+requisi%C3%A7%C3%B5es\u0026amp;theme=9e9623747e20268e9ce176d1\u0026amp;signature=72f1985776047d593975e86ff301ae8085553b305ab4da4711fd19d7661ce0de\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Salvy API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#141414\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.salvy.com.br/api-reference/v2/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.salvy.com.br/#organization\",\"name\":\"Salvy API\",\"url\":\"https://docs.salvy.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/logo/light.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=7178c70a1bd802f95c5ee9f7b1db46eb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.salvy.com.br#website\",\"name\":\"Salvy API\",\"url\":\"https://docs.salvy.com.br\",\"publisher\":{\"@id\":\"https://docs.salvy.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.salvy.com.br/api-reference/v2/introduction#webpage\",\"url\":\"https://docs.salvy.com.br/api-reference/v2/introduction\",\"name\":\"Introdução\",\"description\":\"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.\",\"dateModified\":\"2026-08-07T21:15:26.612Z\",\"isPartOf\":{\"@id\":\"https://docs.salvy.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.salvy.com.br/api-reference/v2/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.salvy.com.br/api-reference/v2/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Salvy API\",\"item\":\"https://docs.salvy.com.br\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introdução\",\"item\":\"https://docs.salvy.com.br/api-reference/v2/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.salvy.com.br/api-reference/v2/introduction#article\",\"headline\":\"Introdução\",\"name\":\"Introdução\",\"description\":\"A API da Salvy permite integrar seus sistemas aos produtos da plataforma. Nesta documentação você encontrará tudo o que precisa para autenticar suas requisições, entender os ambientes disponíveis e começar a utilizar os endpoints.\",\"url\":\"https://docs.salvy.com.br/api-reference/v2/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.salvy.com.br/api-reference/v2/introduction#webpage\"},\"dateModified\":\"2026-08-07T21:15:26.612Z\",\"publisher\":{\"@id\":\"https://docs.salvy.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.salvy.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Salvy API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Salvy API","nav":{"global":null,"tabs":[{"tab":"Referência API","versions":[{"version":"v3","default":true,"pages":[{"title":"v3","href":"/api-reference/v3/introduction"}]},{"version":"v2","groups":[{"group":"Documentação","pages":[{"title":"Introdução","href":"/api-reference/v2/introduction"},{"title":"Ambientes","description":"Entenda os ambientes de sandbox e produção da API da Salvy e como alternar entre eles","href":"/api-reference/v2/environments"},{"title":"Chaves de API","href":"/api-reference/v2/api-keys"},{"title":"Branding para integrações","href":"/api-reference/v2/branding"},{"title":"Deprecação","href":"/api-reference/v2/deprecation"},{"title":"Limites de requisição","href":"/api-reference/v2/rate-limits"}]},{"group":"Números virtuais","pages":[{"title":"Introdução a números virtuais","href":"/api-reference/v2/virtual-phone-accounts/introduction"},{"title":"Criar número virtual","openapi":"api-reference/v2/openapi.json POST /api/v2/virtual-phone-accounts","href":"/api-reference/v2/virtual-phone-accounts/create"},{"title":"Buscar número virtual por ID","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts/{id}","href":"/api-reference/v2/virtual-phone-accounts/get"},{"title":"Atualizar número virtual","openapi":"api-reference/v2/openapi.json PATCH /api/v2/virtual-phone-accounts/{id}","href":"/api-reference/v2/virtual-phone-accounts/update"},{"title":"Listar números virtuais","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts","href":"/api-reference/v2/virtual-phone-accounts/list"},{"title":"Cancelar número virtual","openapi":"api-reference/v2/openapi.json DELETE /api/v2/virtual-phone-accounts/{id}","href":"/api-reference/v2/virtual-phone-accounts/cancel"},{"title":"Listar disponibilidade de DDDs","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts/area-codes","href":"/api-reference/v2/virtual-phone-accounts/list-area-codes"},{"title":"Listar mensagens SMS recebidas","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts/{id}/sms-messages","href":"/api-reference/v2/virtual-phone-accounts/list-sms-messages"},{"title":"Simular recebimento de SMS","openapi":"api-reference/v2/openapi.json POST /api/v2/virtual-phone-accounts/{id}/sms","href":"/api-reference/v2/virtual-phone-accounts/simulate-sms"}]},{"group":"Colaboradores","pages":[{"title":"Introdução à API de colaboradores","sidebarTitle":"Introdução a colaboradores","href":"/api-reference/v2/employees/introduction"},{"title":"Sincronizar colaboradores","openapi":"api-reference/v2/openapi.json POST /api/v2/employees/sync","href":"/api-reference/v2/employees/sync"}]},{"group":"Equipamentos","pages":[{"title":"Listar equipamentos","openapi":"api-reference/v2/openapi.json GET /api/v2/assets","href":"/api-reference/v2/assets/list"},{"title":"Buscar equipamento por ID","openapi":"api-reference/v2/openapi.json GET /api/v2/assets/{id}","href":"/api-reference/v2/assets/get"},{"title":"Criar equipamento","openapi":"api-reference/v2/openapi.json POST /api/v2/assets","href":"/api-reference/v2/assets/create"},{"title":"Atualizar equipamento","openapi":"api-reference/v2/openapi.json POST /api/v2/assets/{id}","href":"/api-reference/v2/assets/update"},{"title":"Arquivar equipamento","openapi":"api-reference/v2/openapi.json POST /api/v2/assets/{id}/archive","href":"/api-reference/v2/assets/archive"},{"title":"Registrar anotação na linha do tempo","openapi":"api-reference/v2/openapi.json POST /api/v2/assets/{id}/timeline-notes","href":"/api-reference/v2/assets/create-timeline-note"}]},{"group":"Webhooks","pages":[{"title":"Introdução a Webhooks","href":"/api-reference/v2/webhooks/introduction"},{"title":"Verificando Webhooks","href":"/api-reference/v2/webhooks/verifying-payloads"},{"title":"SMS recebido","openapi":"api-reference/v2/openapi.json webhook sms.received","href":"/api-reference/v2/webhooks/sms-received"}]}]},{"version":"v1","pages":[{"title":"v1","href":"/api-reference/v1/introduction"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp-guide/overview"}]}]},"basePath":"","title":"Introdução - Salvy API","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":[],"chunks":[]}
