Projetos
GET
https://api.smelter.ai/v2/projects
Retorna a lista de projetos junto com suas configurações. O exemplo de resposta:
{
"data":[
{
"title":"Nome da minha marca",
"channel_name":"abcdef",
"query_params":{
"channel_keywords_include":["palavra-chave um", "palavra-chave dois"],
"channel_keywords_exclude":["algo a ser excluído"],
"channel_languages": ["eng"],
"channel_source_names": ["myhost.com"]
}
},
{
"title":"Nome da minha segunda marca",
"channel_name":"bcdfg",
"query_params":{
"channel_keywords_include":["segunda marca",
"channel_keywords_exclude":[],
"channel_languages": ["por"],
"channel_source_names": ["myhost2.com"]
}
}, ...
]
}
GET
https://api.smelter.ai/v2/projects/<project_name>
Retorna as configurações de um único projeto. O exemplo de resposta:
{
"data":
{
"title":"Nome da minha marca",
"channel_name":"abcdef",
"query_params":{
"channel_keywords_include":["palavra-chave um", "palavra-chave dois"],
"channel_keywords_exclude":["algo a ser excluído"],
"channel_languages": ["eng"],
"channel_source_names": ["myhost.com"]
}
}
}
Os dados são os mesmos do "endpoint" (ponto final) anterior que lista todos os projetos juntamente com suas configurações.
PUT
https://api.smelter.ai/v2/projects/<project_name>
O conteúdo deve ter o seguinte formato. Todos os campos devem ser especificados, caso contrário, eles podem ser perdidos.
O cenário recomendado para atualizar as configurações do projeto é obter as configurações atuais usando GET, fazer as alterações e PUT as configurações completas. O exemplo de resposta:
"title":"Nome da minha marca",
"channel_name":"abcdef",
"query_params":{
"channel_keywords_include":["palavra-chave um", "palavra-chave dois"],
"channel_keywords_exclude":["algo a ser excluído"],
"channel_languages": ["eng"],
"channel_source_names": ["myhost.com"]
}
Se tudo estiver bem, retorna o código 200 que contém as novas configurações do projeto.
DELETE
https://api.smelter.ai/v2/projects/<project_name>
Retorna o código 204 sem conteúdo.
POST
https://api.smelter.ai/v2/create_project
Aceita o conteúdo no formato:
{
"title":"Título de seu canal",
"query_params": {
"channel_keywords_include":["palavra-chave um, palavra-chave dois"]
}
}
Quando o projeto é criado, ele responde com o código 200 que contém as configurações do projeto.