Skip to main content

Intro

Getting Started​

The following explains what is required to use the API and how we can test if the connection is successful.

Prerequisites​

  1. you have an active account on the Semodia Platform, if not register here
  2. you are approved to use the API, if not contact info@semodia.com
  3. you have a valid API key, if not follow the instructions Get Your API Key

Ping​

Next, we send a GET request to our authorized ping interface. The following C# snippet shows a possible request that uses the generated API key in the request header. If you use the snippet, be sure to replace >>>>>---YOUR-API-KEY---<<<<< with your own key!

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "api.mtp.semodia.com/v1/ping/key");
request.Headers.Add("x-api-key", ">>>>>---YOUR-API-KEY---<<<<<");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

If the request was successful, the API returns the status code 200 (Ok). If the key is missing or invalid, the status code 401 (Unauthorized) is returned.

Next​

Read our API documentation to get an overview of the defined interfaces.