# API Short

authorization: Pode ser obtido através da plataforma no link: App SmartTalks.ai

# Headers Obrigatórios

Header	Tipo	Obrigatório	Descrição
`authorization`	`Authorization Bearer Token`	✔️	A chave da sua API
`accept`	`application/json`	✔️

# Buscar um short/qrCode pelo o _id

Para buscar um short pelo _id, será necessário fazer um requisição do tipo GET para a API da seguinte forma:

  GET https://pandora.smarttalks.ai/v1/short/[ _id ]

Parâmetro	Tipo	Obrigatório	Descrição
`_id`	`ObjectID`		Indentificador do short

curl -X GET https://pandora.smarttalks.ai/v1/short/63b720ff5de82e23266384a4  \
  -H 'Content-Type: application/json'
     'Authorization: "{{apiToken}}"'

Exemplo de retorno:

{
"_id": "63b720ff5de82e23266384a4",
"status": true,
"groupId": "624f20077714b7625f029fe3",
"accountId": "624f45692cd11e345180bfd1",
"timestamp": 1672945919180,
"original": "https://www.youtube.com",
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIQAAACECAYAAABRRIOnAAAAAklEQVR4AewaftIAAAOESURBVO3BQY4cSQIDQfdA/f/LXB3mwL0EkMhqjTSgmfmFmX8cZsphphxmymGmHGbKYaYcZsphphxmymGmHGbKYaYcZsphphxmyoeXVH6nJDSVN5Jwo3KThBuV3ykJbxxmymGmHGbKhy9Lwjep3CShqdwkoam0JLQk3Ki0JNwk4ZtUvukwUw4z5TBTPvwwlSeS8EYSnkjCjUpLQkvCGypPJOEnHWbKYaYcZsqHv5xKS0JTeSIJLQk3Ki0Jf7PDTDnMlMNM+TD/R6Uloan8lx1mymGmHGbKhx+WhD9JEm5UmkpLQlN5Iwl/ksNMOcyUw0z58GUqfxOVloSm8k0qf7LDTDnMlMNM+fBSEv5kSWgqTyShqTyRhL/JYaYcZsphpnx4SaUl4QmVloSm8oRKS8JNEm5UbpLQVL4pCTcqLQlvHGbKYaYcZor5hS9SuUnCGyotCTcqN0loKi0JTeUmCTcqTyShqbQkfNNhphxmymGmfPiyJNyotCTcqLQkNJWbJNyotCQ0lTdU3lBpSfhJh5lymCmHmWJ+4YtUbpLwhkpLwo3KTRKaSkvCEyo3SXhC5SYJ33SYKYeZcpgpH/5lKi0JTeUJlSdUWhKayk0SvknlCZWWhDcOM+UwUw4zxfzCCyotCTcqTyThDZWWhKbyRhLeUGlJuFFpSfimw0w5zJTDTDG/8INU/k1JaCotCU3liSQ8ofJGEn7SYaYcZsphpphf+I1UWhKaSktCU/mmJNyoPJGEpvJEEprKTRK+6TBTDjPlMFM+vKRyk4Q3VFoSblRuktBUbpJwo9JU3lC5ScJPOsyUw0w5zBTzC38xlZsk3Ki0JDSVJ5LwhEpLwr/pMFMOM+UwUz68pPI7JeENlZaEmyTcqNyotCT8yQ4z5TBTDjPlw5cl4ZtUbpLwTSrflIQnVN5IwhuHmXKYKYeZ8uGHqTyRhCdUvikJTaUloak0lZ+UhKbyTYeZcpgph5ny4S+XhBuVloQblTeS0FRuknCj0lR+0mGmHGbKYaZ8+I9RaUloKi0JLQlNpam8kYQblZaEptKS8E2HmXKYKYeZ8uGHJeFPkoSmcpOEJ1RaEprKEyq/02GmHGbKYaZ8+DKV30mlJaGp3CThJ6m0JDyhcqPSkvDGYaYcZsphpphfmPnHYaYcZsphphxmymGmHGbKYaYcZsphphxmymGmHGbKYaYcZsphpvwPfRV9JdF/qxcAAAAASUVORK5CYII=",
"label": "Run google",
"caption": "",
"isActive": true,
"phone": "",
"type": "url",
"createdBy": "62508886669d866ef63ab355",
"createdAt": "2023-01-05T19:11:59.212Z",
"updatedAt": "2023-01-05T19:11:59.212Z",
"__v": 0,
"updatedBy": "62508886669d866ef63ab355"
}

# Buscar shorts

  GET https://pandora.smarttalks.ai/v1/short

Para buscar os seus shorts, será necessário fazer um requisição do tipo GET para a API da seguinte forma:

curl -X GET https://pandora.smarttalks.ai/v1/short/\
  -H 'Content-Type: application/json'
     'Authorization: "{{apiToken}}"'

Exemplo de retorno:
[
{
"_id": "63b720ff5de82e23266384a4",
"status": true,
"groupId": "624f20077714b7625f029fe3",
"accountId": "624f45692cd11e345180bfd1",
"timestamp": 1672945919180,
"original": "https://www.youtube.com",
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIQAAACECAYAAABRRIOnAAAAAklEQVR4AewaftIAAAOESURBVO3BQY4cSQIDQfdA/f/LXB3mwL0EkMhqjTSgmfmFmX8cZsphphxmymGmHGbKYaYcZsphphxmymGmHGbKYaYcZsphphxmyoeXVH6nJDSVN5Jwo3KThBuV3ykJbxxmymGmHGbKhy9Lwjep3CShqdwkoam0JLQk3Ki0JNwk4ZtUvukwUw4z5TBTPvwwlSeS8EYSnkjCjUpLQkvCGypPJOEnHWbKYaYcZsqHv5xKS0JTeSIJLQk3Ki0Jf7PDTDnMlMNM+TD/R6Uloan8lx1mymGmHGbKhx+WhD9JEm5UmkpLQlN5Iwl/ksNMOcyUw0z58GUqfxOVloSm8k0qf7LDTDnMlMNM+fBSEv5kSWgqTyShqTyRhL/JYaYcZsphpnx4SaUl4QmVloSm8oRKS8JNEm5UbpLQVL4pCTcqLQlvHGbKYaYcZor5hS9SuUnCGyotCTcqN0loKi0JTeUmCTcqTyShqbQkfNNhphxmymGmfPiyJNyotCTcqLQkNJWbJNyotCQ0lTdU3lBpSfhJh5lymCmHmWJ+4YtUbpLwhkpLwo3KTRKaSkvCEyo3SXhC5SYJ33SYKYeZcpgpH/5lKi0JTeUJlSdUWhKayk0SvknlCZWWhDcOM+UwUw4zxfzCCyotCTcqTyThDZWWhKbyRhLeUGlJuFFpSfimw0w5zJTDTDG/8INU/k1JaCotCU3liSQ8ofJGEn7SYaYcZsphpphf+I1UWhKaSktCU/mmJNyoPJGEpvJEEprKTRK+6TBTDjPlMFM+vKRyk4Q3VFoSblRuktBUbpJwo9JU3lC5ScJPOsyUw0w5zBTzC38xlZsk3Ki0JDSVJ5LwhEpLwr/pMFMOM+UwUz68pPI7JeENlZaEmyTcqNyotCT8yQ4z5TBTDjPlw5cl4ZtUbpLwTSrflIQnVN5IwhuHmXKYKYeZ8uGHqTyRhCdUvikJTaUloak0lZ+UhKbyTYeZcpgph5ny4S+XhBuVloQblTeS0FRuknCj0lR+0mGmHGbKYaZ8+I9RaUloKi0JLQlNpam8kYQblZaEptKS8E2HmXKYKYeZ8uGHJeFPkoSmcpOEJ1RaEprKEyq/02GmHGbKYaZ8+DKV30mlJaGp3CThJ6m0JDyhcqPSkvDGYaYcZsphpphfmPnHYaYcZsphphxmymGmHGbKYaYcZsphphxmymGmHGbKYaYcZsphpvwPfRV9JdF/qxcAAAAASUVORK5CYII=",
"label": "Run google",
"caption": "",
"isActive": true,
"phone": "",
"type": "url",
"createdBy": "62508886669d866ef63ab355",
"createdAt": "2023-01-05T19:11:59.212Z",
"updatedAt": "2023-01-05T19:11:59.212Z",
"__v": 0,
"updatedBy": "62508886669d866ef63ab355"
}
]

# Criar um short de url simples.

Para criar um short de url simples, será necessário fazer um requisição do tipo PUT da seguite forma:

  PUT https://pandora.smarttalks.ai/v1/short

Propriedades do corpo da requisição	Tipo	Obrigatório	Padrão	Descrição
`label`	`String`	✔️		Rótulo do short
`type`	`String`		'url'	Tipo de encurtador url
`original`	`String`	✔️	''	Link original Ex:('https://www.google.com')

curl -X PUT https://pandora.smarttalks.ai/api/v1/short \
  -H 'Content-Type: application/json'
     'accept: application/json'\
     'Authorization: "{{apiToken}}"'
  -d '{ "label": "url text", "type": "url", "original": "https://www.google.com"}'

Exemplo de retorno:

{
"status": true,
"groupId": "624f20077714b7625f029fe3",
"accountId": "624f45692cd11e345180bfd1",
"timestamp": 1674850168636,
"original": "https://www.google.com",
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIQAAACECAYAAABRRIOnAAAAAklEQVR4AewaftIAAAOKSURBVO3BQY7kSAIDQWcg//9l3zrMgScBgpQ10700iz+Y+cdhphxmymGmHGbKYaYcZsphphxmymGmHGbKYaYcZsphphxmymGmfHgoCb9J5U1JuKLyRBJ+k8oTh5lymCmHmfLhZSpvSsIdSWgqTyThDpUrKm9KwpsOM+UwUw4z5cOXJeEOlTuScCUJV1SuJKGptCQ8kYQ7VL7pMFMOM+UwUz78n1FpSWgqTeWKyt/kMFMOM+UwUz78ZVSuJKGpXElCU2lJaCp/ssNMOcyUw0z58GUqvykJTeVKEppKU2lJeJPKf8lhphxmymGmfHhZEv5NKi0JTaUl4UoSmkpLwh1J+C87zJTDTDnMlPiDP1gSrqi8KQlN5W9ymCmHmXKYKfEHDyShqbQkvEnljiQ0lZaEKypPJOFNKt90mCmHmXKYKfEHDyThTSpXkvBNKi0JTaUloal8UxKaypsOM+UwUw4z5cMvU7kjCU2lJaGpfFMSmkpLQlNpSbhD5UoSmsoTh5lymCmHmfLhZSp3JOGKyhNJuKLSktBUriShqVxReUKlJeFNh5lymCmHmfLhIZWWhKbyRBKaSlN5IglPqLQkPKHSkvCbDjPlMFMOM+XDQ0m4IwlNpSWhqbQkNJUrKleS0FSeULmShKbSktBUWhKaypsOM+UwUw4z5cPLVO5IQlNpSWgqdyShqVxJwm9KwhNJaCpPHGbKYaYcZsqHL0tCU2lJaEloKi0Jd6jcodKScEWlJaGptCRcUbmi0pLwpsNMOcyUw0z58C9TaUloSWgqLQlvSsIdSbiShCeS0FSaypsOM+UwUw4zJf7gD5aEpnJHEu5QaUloKnck4YrKbzrMlMNMOcyUDw8l4TepNJWWhDtUvikJTeWKSkvCHSpPHGbKYaYcZsqHl6m8KQlXknCHyh1JeELljiQ0ld90mCmHmXKYKR++LAl3qLxJpSWhqbwpCU+otCQ0lZaEpvLEYaYcZsphpnz4y6i0JDyh0pJwRaUloam0JLQkXEnCNx1mymGmHGbKh79MEprKN6m0JDSVKyotCVdUWhLedJgph5lymCkfvkzlm1SuJKGp3JGEptKS0FRaEp5Q+U2HmXKYKYeZ8uFlSfhNSWgqTaUl4YpKU2lJaCotCW9Kwm86zJTDTDnMlPiDmX8cZsphphxmymGmHGbKYaYcZsphphxmymGmHGbKYaYcZsphphxmyv8AOPOQFTGhMZ8AAAAASUVORK5CYII=",
"label": "url text",
"caption": "",
"isActive": true,
"phone": "",
"type": "url",
"createdBy": "6320885f8bc9033b9bbc0875",
"_id": "63d42f786becbf6d23ae2f34",
"createdAt": "2023-01-27T20:09:28.656Z",
"updatedAt": "2023-01-27T20:09:28.656Z",
"__v": 0
}

# Criar um short de whatsapp.

Para criar um short de whatsapp, será necessário fazer um requisição do tipo PUT da seguite forma:

  PUT https://pandora.smarttalks.ai/v1/short

Propriedades do corpo da requisição	Tipo	Obrigatório	Padrão	Descrição
`label`	`String`	✔️		Rótulo do short
`type`	`String`		'whatsapp'	Tipo de encurtador whatsapp
`original`	`String`	✔️	''	Link original Ex:('https://api.whatsapp.com/send?phone=5548999999999&text=Olá%20tudo%20bem?')
`phone`	`String`			Número do whatsapp
`message`	`String`			Mensagem a ser enviada, caso o type for whatsapp

curl -X PUT https://pandora.smarttalks.ai/v1/short \
  -H 'Content-Type: application/json'
     'accept: application/json'\
     'Authorization: "{{apiToken}}"'
  -d '{ "label": "whatsapp text", "type": "whatsapp", "original": "https://api.whatsapp.com/send?phone=5511987646856&text=Olá%20tudo%20bem?", "phone": "5511987646856", "message": "Olá%20tudo%20bem?"}'

Exemplo de retorno:

{
"status": true,
"groupId": "624f20077714b7625f029fe3",
"accountId": "624f45692cd11e345180bfd1",
"timestamp": 1674851199492,
"original": "https://api.whatsapp.com/send?phone=5511987646856&text=Olá%20tudo%20bem?",
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIQAAACECAYAAABRRIOnAAAAAklEQVR4AewaftIAAAOJSURBVO3BO47kWAADwcwH3f/K3DHWoCVAUFXPB4wwvzDzv8NMOcyUw0w5zJTDTDnMlMNMOcyUw0w5zJTDTDnMlMNMOcyUw0y5eEnlJyWhqbQkNJUnktBU7iThjspPSsIbh5lymCmHmXLxYUn4JJU7SXgjCXeScEelJeFOEj5J5ZMOM+UwUw4z5eLLVJ5IwhsqLQlN5QmVloSWhDdUnkjCNx1mymGmHGbKxV9O5Q2VloSWhDsqLQl/s8NMOcyUw0y5+MckoancSUJTaUloKv+yw0w5zJTDTLn4siT8TkloKk+otCQ0lTeS8Cc5zJTDTDnMlIsPU/mTqLQkNJWWhKbySSp/ssNMOcyUw0y5eCkJfxOVloQ7SWgqTyThb3KYKYeZcpgpFy+ptCQ8odKS0FTeSEJTeULlThKayicl4Y5KS8Ibh5lymCmHmXLxUhLuqLQk3FFpSWgqLQl3VJ5QaUloKk2lJeGOyhsqLQmfdJgph5lymCkXH6bSkvCGSkvCJ6m0JDSVN1TeUGlJ+KbDTDnMlMNMMb/wgsoTSXhD5U4SmsobSXhC5U4SnlC5k4RPOsyUw0w5zJSLD0vCJ6k8odKScEelJaGp3EnCJ6k8odKS8MZhphxmymGmXHyZSkvCE0m4o/JJKm8k4QmVloQ7Ki0Jn3SYKYeZcpgpFy8l4Q2VJ5LwhkpLQlP5JpU7KneS8E2HmXKYKYeZcvFlSWgqTyThiSS8kYSmckelJaGpPJGEptJUWhI+6TBTDjPlMFPML7ygcicJTaUloancScIdlTtJaCotCU+o/KQkfNNhphxmymGmXLyUhCeScCcJT6j8JJU7SXhCpSXhdzrMlMNMOcyUi5dUflIS7iShqdxJwhNJaCp3VFoS/mSHmXKYKYeZcvFhSfgklTtJaCp3VO4koam8kYQnVN5IwhuHmXKYKYeZcvFlKk8k4QmVloQ3VFoS7qg0lW9KQlP5pMNMOcyUw0y5+Msloam0JLyh0pJwJwlN5U4S7qg0lW86zJTDTDnMlIt/TBKaSkvCGypvJOGOSktCU2lJ+KTDTDnMlMNMufiyJPxOSbij0pLQVFoS7qi0JDSVJ1R+0mGmHGbKYaZcfJjKT1JpSbij0pJwJwlvqLQkPKFyR6Ul4Y3DTDnMlMNMMb8w87/DTDnMlMNMOcyUw0w5zJTDTDnMlMNMOcyUw0w5zJTDTDnMlMNM+Q9q8Xk48q3fqAAAAABJRU5ErkJggg==",
"label": "whatsapp text",
"caption": "",
"isActive": true,
"phone": "5511987646856",
"message": "Olá%20tudo%20bem?",
"type": "whatsapp",
"createdBy": "6320885f8bc9033b9bbc0875",
"_id": "63d4337f6becbf6d23ae2f39",
"createdAt": "2023-01-27T20:26:39.500Z",
"updatedAt": "2023-01-27T20:26:39.500Z",
"__v": 0
}

# Editar short.

Para editar um short/qrCode, será necessário fazer um requisição do tipo PATCH da seguite forma:

  PATCH https://pandora.smarttalks.ai/v1/short/63d42f786becbf6d23ae2f34

Propriedades do corpo da requisição	Tipo	Obrigatório	Padrão	Descrição
`label`	`String`	✔️		Rótulo do short
`isActive`	`Boolean`			Desativa ou ativa o link
`original`	`String`	✔️	''	Link original Ex:('https://www.youtube.com')

curl -X PATCH https://pandora.smarttalks.ai/v1/short/63d42f786becbf6d23ae2f34 \
  -H 'Content-Type: application/json'
     'accept: application/json'\
     'Authorization: "{{apiToken}}"'
  -d '{ "label": "url text", "isActive": true, "original": "https://www.youtube.com"}'

Exemplo de retorno:

{
"acknowledged": true,
"modifiedCount": 1,
"upsertedId": null,
"upsertedCount": 0,
"matchedCount": 1
}

# Editar short whatsapp.

Para editar um short/qrCode whatsapp, será necessário fazer um requisição do tipo PATCH da seguite forma:

  PATCH https://pandora.smarttalks.ai/v1/short/63d4337f6becbf6d23ae2f39

Propriedades do corpo da requisição	Tipo	Obrigatório	Padrão	Descrição
`label`	`String`	✔️		Rótulo do short
`isActive`	`Boolean`			Desativa ou ativa o encutador whatsapp
`original`	`String`	✔️	''	Link original Ex:('https://api.whatsapp.com/send?phone=5548999999999&text=Olá%20tudo%20bem?')
`phone`	`String`			Número do whatsapp
`message`	`String`			Mensagem a ser enviada, caso o type for whatsapp

curl -X PATCH https://pandora.smarttalks.ai/v1/short/63d4337f6becbf6d23ae2f39 \
  -H 'Content-Type: application/json'
     'accept: application/json'\
     'Authorization: "{{apiToken}}"'
  -d '{ "label": "whatsapp test", "isActive": true}'

Exemplo de retorno:

{
"acknowledged": true,
"modifiedCount": 1,
"upsertedId": null,
"upsertedCount": 0,
"matchedCount": 1
}

# Excluir short.

Para excluir um short/qrCode, será necessário fazer um requisição do tipo DELETE da seguite forma:

  DELETE https://pandora.smarttalks.ai/v1/short/63d4337f6becbf6d23ae2f39

curl -X DELETE https://pandora.smarttalks.ai/v1/short/63d4337f6becbf6d23ae2f39 \
  -H 'Content-Type: application/json'
     'accept: application/json'\
     'Authorization: "{{apiToken}}"'

Exemplo de retorno:

{
"acknowledged": true,
"modifiedCount": 1,
"upsertedId": null,
"upsertedCount": 0,
"matchedCount": 1
}

Last Updated: 10/24/2024, 3:59:20 PM