CSC (v1)

Get remote service information

Use this endpoint to get remote service information, and a list of implemented API methods, for a given language code (ISO 639-1:2002).

lang — (ISO 639-1:2002) Language code. Required.

post/csc/v1/info

Request

Request body

langstring

Request a preferred language of the response to the Remote Service, specified according to RFC 3066. If present, the Remote Service shall provide languagespecific responses using the specified language. If the specified language is not supported then it shall provide these responses in the language as specified in the lang output parameter.

Example request

{
  "lang": "en-US"
}

Response

Remote service details

langstring

The language used in the responses, specified according to RFC 3066.

specsstring

The version of this specification implemented by the provider. The format of the string is Major.Minor.x.y, where Major is a number equivalent to the API version (e.g. 1 for API v1) and Minor is a number identifying the version update, while x and y are subversion numbers.

namestring

The commercial name of the Remote Service.

logostring

The URI of the image file containing the logo of the Remote Service which shall be published online. The image shall be in either JPEG or PNG format and not larger than 256x256 pixels.

regionstring

The ISO 3166-1 Alpha-2 code of the Country where the Remote Service provider is established (e.g. ES for Spain).

descriptionstring

Contains a free form description of the Remote Service in the lang language. The maximum size of the string shall be 255 characters.

oauth2string

Specifies the complete URI of the OAuth 2.0 service authorization endpoint provided by the Remote Service. The parameter is required only if the authType parameter contains “oauth2code” or “oauth2implicit”.

methodsstring[]
authTypestring[]

Example response

{
  "lang": "en-US",
  "name": "ACME Trust Services",
  "logo": "https://service.domain.org/images/logo.png",
  "region": "IT",
  "oauth2": "https://www.domain.org/oauth2/authorize"
}

Changes

No recorded changes to this operation across all 1 revision of this API.