Class: ApiBrasil::Services::Platform::CatalogService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/api_brasil/services/platform/catalog_service.rb

Overview

Catalogo publico da plataforma: APIs, planos, documentacoes e servidores. A maioria das rotas e publica (nao exige Bearer Token).

Instance Attribute Summary

Attributes inherited from BaseService

#http

Instance Method Summary collapse

Methods inherited from BaseService

#delete, #download, #get, #initialize, #patch, #post, #put

Constructor Details

This class inherits a constructor from ApiBrasil::Services::BaseService

Instance Method Details

#api(identifier, options = {}) ⇒ Object

Detalha uma API por identificador: GET /apis/{identifier}.

Returns:

  • (Object) 


27
28
29
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 27

def api(identifier, options = {})
  get("/apis/#{identifier}", options)
end

#api_by_name(name, options = {}) ⇒ Object

Detalha uma API pelo nome: GET /apis/name/{name}.

Returns:

  • (Object) 


34
35
36
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 34

def api_by_name(name, options = {})
  get("/apis/name/#{Core::HttpClient.escape_path_segment(name)}", options)
end

#api_categories(options = {}) ⇒ Object

Categorias de APIs: GET /apis/categories.

Returns:

  • (Object) 


41
42
43
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 41

def api_categories(options = {})
  get("/apis/categories", options)
end

#apis(search = nil, options = {}) ⇒ Object

Lista/busca APIs disponiveis: GET /apis?search=.

Returns:

  • (Object) 


16
17
18
19
20
21
22
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 16

def apis(search = nil, options = {})
  options = Core::HttpClient.normalize_keys(options)
  query = search.nil? || search.to_s.empty? ? {} : { "search" => search }
  options[:query] = query.merge(options[:query] || {})

  get("/apis", options)
end

#apis_by_device(device_token, options = {}) ⇒ Object

APIs vinculadas a um device: GET /apis/device/{device_token}.

Returns:

  • (Object) 


55
56
57
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 55

def apis_by_device(device_token, options = {})
  get("/apis/device/#{device_token}", options)
end

#documentations(options = {}) ⇒ Object

Documentacoes: GET /documentations.

Returns:

  • (Object) 


69
70
71
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 69

def documentations(options = {})
  get("/documentations", options)
end

#documentations_by_server(server_search, options = {}) ⇒ Object

Documentacao por servidor: GET /documentations/server/{server_search}.

Returns:

  • (Object) 


76
77
78
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 76

def documentations_by_server(server_search, options = {})
  get("/documentations/server/#{server_search}", options)
end

#endpoint_body(body, options = {}) ⇒ Object

Body esperado por uma action: POST /endpoint/body.

Returns:

  • (Object) 


98
99
100
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 98

def endpoint_body(body, options = {})
  post("/endpoint/body", body, options)
end

#endpoint_url(body, options = {}) ⇒ Object

Resolve a URL de uma action (descoberta dinamica de endpoints): POST /endpoint/url.

Returns:

  • (Object) 


91
92
93
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 91

def endpoint_url(body, options = {})
  post("/endpoint/url", body, options)
end

#my_apis(options = {}) ⇒ Object

APIs contratadas pelo usuario (autenticado): GET /apis/list.

Returns:

  • (Object) 


48
49
50
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 48

def my_apis(options = {})
  get("/apis/list", options)
end

#plans(options = {}) ⇒ Object

Planos disponiveis: GET /plans.

Returns:

  • (Object) 


62
63
64
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 62

def plans(options = {})
  get("/plans", options)
end

#servers(options = {}) ⇒ Object

Servidores disponiveis: GET /servers.

Returns:

  • (Object) 


83
84
85
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 83

def servers(options = {})
  get("/servers", options)
end

#status(options = {}) ⇒ Object

Status do gateway: GET /status.

Returns:

  • (Object) 


105
106
107
 
# File 'lib/api_brasil/services/platform/catalog_service.rb', line 105

def status(options = {})
  get("/status", options)
end