Listar convênios
GET
/v1/catalog/credit-groups/options
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://ms-credit-api-az.kemosoft.com.br/v1/catalog/credit-groups/options"), Headers = { { "api-key", "<api-key>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://ms-credit-api-az.kemosoft.com.br/v1/catalog/credit-groups/options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://ms-credit-api-az.kemosoft.com.br/v1/catalog/credit-groups/options")) .header("api-key", "<api-key>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build();HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());System.out.println(response.body());const url = 'https://ms-credit-api-az.kemosoft.com.br/v1/catalog/credit-groups/options';const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://ms-credit-api-az.kemosoft.com.br/v1/catalog/credit-groups/options \ --header 'api-key: <api-key>'Lista os convênios ativos. Use o campo slug como creditGroup na qualificação e na proposta.
Autorizações
Seção intitulada “Autorizações”Parâmetros
Seção intitulada “Parâmetros”Parâmetros de consulta
Seção intitulada “Parâmetros de consulta”logoAsBase64
boolean
Quando true, inclui o logo do convênio em Base64 no campo logoBase64, além de logoUrl.
Respostas
Seção intitulada “Respostas”Convênios disponíveis.
Tipo de mídiaapplication/json
Array<object>
object
id
obrigatório
string formato: uuid
slug
obrigatório
string
name
obrigatório
string
category
obrigatório
string
logoUrl
string
logoBase64
string
preview
boolean
Exemplo gerado
[ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "slug": "example", "name": "example", "category": "example", "logoUrl": "example", "logoBase64": "example", "preview": true }]Filtro inválido.