{"info":{"_postman_id":"f4b8cb21-5799-44e6-adf0-459983d8f294","name":"API | TEM Saúde","description":"

TEM Saúde Deep Link API facilitates the creation of deep links, allowing users to directly access specific features within the application. This streamlined process enhances user experience by providing immediate access to targeted functionalities. Follow these steps to generate a deep link:

Acquire TokenZeus: Begin by obtaining the TokenZeus. This is achieved through the Login - Company endpoint. Provide your company's credentials and parameters to authenticate and receive the token. This token is essential for authorizing the deep link generation.
Generate Deep Link: With the TokenZeus acquired, proceed to the Generate Deep Link endpoint. Here, you must input the correct parameters that define the specific application feature you wish to link to. The endpoint will process these parameters and generate a unique deep link.

Note: The parameters required for deep link generation are crucial for directing the user to the correct feature within the application. Ensure accuracy in this step for optimal functionality.

By following these steps, you can effectively create deep links that enhance your application's navigability and user experience.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29393887","collectionId":"f4b8cb21-5799-44e6-adf0-459983d8f294","publishedId":"2s9YysBgdc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-15T13:22:45.000Z"},"item":[{"name":"Login - Company","event":[{"listen":"test","script":{"id":"ef97fd3f-a0f1-47ad-8d3f-032d9940a8d1","exec":["pm.test(\"Successful POST request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});",""],"type":"text/javascript"}}],"id":"8fdc8f4c-c0ff-4b57-b5c2-172a65a49010","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyId\": \"\",\n \"apiKey\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/api-auth/login","description":"\n

This endpoint is used to authenticate and login to the API.

Request Body

companyId (text, required): The company ID for authentication.
apiKey (text, required): The API key for authentication.

Example:

{\n    \"companyId\": \"your_company_id\",\n    \"apiKey\": \"your_api_key\"\n}\n\n

Response

Status: 200
Content-Type: application/json

Success Response

{\n    \"UUID\": \"\",\n    \"message\": \"\",\n    \"data\": {\n        \"id\": \"\",\n        \"token\": \"\"\n    }\n}\n\n

\n","urlObject":{"path":["v1","api-auth","login"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e1d81e4a-aaec-4e7e-8e52-7b87733b62cd","name":"Invalid Credentials","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyId\": \"\",\n \"apiKey\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/api-auth/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"114"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"72-xYdqfHemL3hQjdtWn7+h37SRgpo\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"UUID\": \"5e15b5a5-d021-4301-a103-7a9512533997\",\n \"message\": \"Login data is not right, no company found.\",\n \"data\": null\n}"},{"id":"ea967449-98de-4ffe-8fd4-d8e2a6697417","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"companyId\": \"\",\n \"apiKey\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/api-auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"114"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"72-xYdqfHemL3hQjdtWn7+h37SRgpo\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"UUID\": \"2f7f9d5a-5c6f-4d39-bed3-21671b306819\",\n \"message\": \"Company login was done\",\n \"data\": {\n \"id\": \"your_company_id\",\n \"token\": \"your_token\"\n }\n}"}],"_postman_id":"8fdc8f4c-c0ff-4b57-b5c2-172a65a49010"},{"name":"Generate Deep Link","event":[{"listen":"test","script":{"id":"ef97fd3f-a0f1-47ad-8d3f-032d9940a8d1","exec":["pm.test(\"Successful POST request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});",""],"type":"text/javascript"}}],"id":"af7f6f7e-4c91-4f49-bd7b-1c7f10f7f60a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientCpf\": \"\", // optional if externalId is provided\n \"externalId\": \"\", // optional if clientCpf is provided\n \"tokenZeus\": \"\", // JWT Token\n \"programCode\": \"\",\n \"feature\": \"\",\n \"showHeader\": \"\",\n \"showFooter\": \"\",\n \"showSummary\": \"\",\n \"expirationTime\": \"\", // in seconds\n \"expiresOnAccess\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/hello/generate_deep_link","description":"

This endpoint makes an HTTP POST request to generate a deep link. The request should include the following parameters in the raw request body:

clientCpf (string): The client's CPF
\n
tokenZeus (string): The Zeus token [JWT]
\n
externalId(string): An external identifier for the request (max: 50 characters)
\n
programCode (integer): The program code
\n
feature (string, required): The specific feature to be included in the deep link. Possible values are:
\n
- editar-meu-perfil-dados - Edit my profile data
  \n
- alterar-senha-saude - Change health account password
  \n
- gerenciar-conta-saude - Manage health account
  \n
- desconto-medicamento - Medication discount
  \n
- gerenciar-dependentes - Manage dependents
  \n
- consulta-24-horas - 24-hour consultation
  \n
- consulta-video - Video consultation
  \n
- exames - Exams
  \n
- consulta-presencial - In-person consultation
  \n
- checkup - Checkup
  \n
\n
showHeader (boolean): A flag to indicate whether to show the header
\n
showFooter (boolean): A flag to indicate whether to show the footer
\n
showSummary (boolean): A flag to indicate whether to show the summary
\n
expirationTime (integer): The expiration time for the deep link
\n
expiresOnAccess (boolean): A flag to indicate if the link expires upon access
\n

Note: Either externalId or clientCpf is required.

The response will have a status code of 200 and a content type of application/json. The response body will include the following fields:

message (string): A message related to the response
\n
data.url (string): The generated deep link URL
\n

\n","urlObject":{"path":["v1","hello","generate_deep_link"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"62032208-c3d0-4e59-aeef-61163b28051d","name":"Success [CPF]","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientCpf\": \"12345678900\",\n \"tokenZeus\": \"\",\n \"programCode\": 123,\n \"feature\": \"some_feature\",\n \"showHeader\": true,\n \"showFooter\": false,\n \"showSummary\": true,\n \"expirationTime\": 3600,\n \"expiresOnAccess\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://develop.dd.meutem.com.br/v1/hello/generate_deep_link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:35:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"453"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"1c5-mc4RRdU/WfYViQ9LeUTfA1YRrvQ\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Deep Link successfully generated\",\n \"data\": {\n \"url\": \"https://app.temsaude.com//deep-link?code=\"\n }\n}"},{"id":"692667b8-f477-44a2-9d52-78aa0efe738f","name":"Success [ExternalId]","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": \"e4560aaf-55c3-4413-b819-7dc439689c5e\",\n \"tokenZeus\": \"\",\n \"programCode\": 123,\n \"feature\": \"some_feature\",\n \"showHeader\": true,\n \"showFooter\": false,\n \"showSummary\": true,\n \"expirationTime\": 3600,\n \"expiresOnAccess\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://develop.dd.meutem.com.br/v1/hello/generate_deep_link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:35:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"453"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"1c5-mc4RRdU/WfYViQ9LeUTfA1YRrvQ\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Deep Link successfully generated\",\n \"data\": {\n \"url\": \"https://app.temsaude.com//deep-link?code=\"\n }\n}"},{"id":"1346b215-ecdf-44a4-85fb-dc04fd2266a7","name":"Program code does not belong to partner","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"programCode\": \"\",\n \"clientCpf\": \"12345678900\",\n \"tokenZeus\": \"\",\n \"feature\": \"some_feature\",\n \"showHeader\": true,\n \"showFooter\": false,\n \"showSummary\": true,\n \"expirationTime\": 3600,\n \"expiresOnAccess\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/hello/generate_deep_link"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:39:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"73"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"49-AgE26wtD11b/D03zhvGOyiHTIOk\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This Program code does not belong to this partner\",\n \"data\": {}\n}"},{"id":"70a5ced1-25d9-4c01-bdaa-6a7b9e0f42ca","name":"Invalid parameters","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"showHeader\": \"\",\n \"clientCpf\": \"12345678900\",\n \"tokenZeus\": \"\",\n \"programCode\": 123,\n \"feature\": \"some_feature\",\n \"showFooter\": false,\n \"showSummary\": true,\n \"expirationTime\": 3600,\n \"expiresOnAccess\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/hello/generate_deep_link"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:41:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"222"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"de-uHU2gHZkbXVLJYbrugY338gf15Y\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"UUID\": \"4d2c5498-083d-469e-bd71-35861714ca1c\",\n \"message\": \"Has a error in your request\",\n \"data\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"showHeader\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"showHeader\",\n \"location\": \"body\"\n }\n ]\n}"}],"_postman_id":"af7f6f7e-4c91-4f49-bd7b-1c7f10f7f60a"},{"name":"Generate Magic Link","event":[{"listen":"test","script":{"id":"ef97fd3f-a0f1-47ad-8d3f-032d9940a8d1","exec":["pm.test(\"Successful POST request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});",""],"type":"text/javascript"}}],"id":"62cf4f2c-2b76-44dd-af52-65c242c5046c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientCpf\": \"\",\n \"tokenzeus\": \"\", // JWT Token\n \"onixCode\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/hello/generate_magic_link","description":"

This endpoint makes an HTTP POST request to generate a magic link. The request should include the following parameters in the raw request body:

clientCpf (string): The client's CPF
\n
tokenzeus (string): The Zeus token [JWT]
\n
onixCode (integer): The onix code
\n

The response will have a status code of 200 and a content type of application/json. The response body will include the following fields:

message (string): A message related to the response
data.url (string): The generated magic link URL

\n","urlObject":{"path":["v1","hello","generate_magic_link"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5152da7b-1cec-4a07-ab76-79ada0eb4442","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientCpf\": \"12345678900\",\n \"tokenzeus\": \"\",\n \"onixCode\": 123\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/hello/generate_magic_link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:35:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"453"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"1c5-mc4RRdU/WfYViQ9LeUTfA1YRrvQ\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Magic Link successfully generated\",\n \"data\": {\n \"url\": \"https://app.temsaude.com//magic-link?tokenzeus=&refreshtoken=\"\n }\n}"},{"id":"920df8d1-ac06-4d72-95b7-99cc3a2bfbbd","name":"Program code does not belong to partner","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"onixCode\": \"\",\n \"clientCpf\": \"12345678900\",\n \"tokenzeus\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/hello/generate_magic_link"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jan 2024 14:39:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"73"},{"key":"Connection","value":"keep-alive"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"tokenzeus,refreshToken"},{"key":"ETag","value":"W/\"49-AgE26wtD11b/D03zhvGOyiHTIOk\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This Program code does not belong to this partner\",\n \"data\": {}\n}"}],"_postman_id":"62cf4f2c-2b76-44dd-af52-65c242c5046c"}]}

API-Auth Login

Request Body

Response

Success Response