Skip to content
This repository has been archived by the owner on Feb 9, 2021. It is now read-only.

Latest commit

 

History

History
105 lines (73 loc) · 5.17 KB

ClientsApi.md

File metadata and controls

105 lines (73 loc) · 5.17 KB

ClientsApi

All URIs are relative to https://api.meltwater.com

Method HTTP request Description
createClientCredentials POST /v2/clients Register new client
deleteClientCredentials DELETE /v2/clients/{client_id} Delete client.

createClientCredentials

ClientCredentials createClientCredentials(userKey, authorization)

Register new client

Register new client Creates a new pair of client credentials (`client_id`/`client_secret` pair). Requires your Meltwater credentials (`email`:`password`) to authenticate. #### Appendix The Base64-encoded `email`:`password` string can be generated in a terminal with following command: $ echo -n &quot;your_email@your_domain.com:your_secret_password&quot; | base64 <i>You will need `base64` installed.</i>

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ClientsApi;


ClientsApi apiInstance = new ClientsApi();
String userKey = "userKey_example"; // String | The `user_key` from [developer.meltwater.com](https://developer.meltwater.com/admin/applications/).
String authorization = "authorization_example"; // String | `email`:`password`    Basic Auth (RFC2617) credentials. Must contain the realm `Basic` followed by a  Base64-encoded `email`:`password` pair using your Meltwater credentials.    #### Example:        Basic bXlfZW1haWxAZXhhbXJzZWNyZXQ=
try {
    ClientCredentials result = apiInstance.createClientCredentials(userKey, authorization);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientsApi#createClientCredentials");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userKey String The `user_key` from developer.meltwater.com.
authorization String `email`:`password` Basic Auth (RFC2617) credentials. Must contain the realm `Basic` followed by a Base64-encoded `email`:`password` pair using your Meltwater credentials. #### Example: Basic bXlfZW1haWxAZXhhbXJzZWNyZXQ=

Return type

ClientCredentials

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteClientCredentials

deleteClientCredentials(userKey, authorization, clientId)

Delete client.

Delete client. Deletes your current client credentials consisting of client_id and client_secret. After calling this resource, you will not be able to use the Meltwater API unless you create a new set of client credentials! Requires your Meltwater credentials (`email`:`password`) to authenticate. #### Appendix The Base64-encoded `email`:`password` string can be generated in a terminal with following command: $ echo -n &quot;your_email@your_domain.com:your_secret_password&quot; | base64 <i>You will need `base64` installed.</i>

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ClientsApi;


ClientsApi apiInstance = new ClientsApi();
String userKey = "userKey_example"; // String | The `user_key` from [developer.meltwater.com](https://developer.meltwater.com/admin/applications/).
String authorization = "authorization_example"; // String | `email`:`password`    Basic Auth (RFC2617) credentials. Must contain the realm `Basic` followed by a  Base64-encoded `email`:`password` pair using your Meltwater credentials.    #### Example:        Basic bXlfZW1haWxAZXhhbXJzZWNyZXQ=
String clientId = "clientId_example"; // String | Client ID
try {
    apiInstance.deleteClientCredentials(userKey, authorization, clientId);
} catch (ApiException e) {
    System.err.println("Exception when calling ClientsApi#deleteClientCredentials");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userKey String The `user_key` from developer.meltwater.com.
authorization String `email`:`password` Basic Auth (RFC2617) credentials. Must contain the realm `Basic` followed by a Base64-encoded `email`:`password` pair using your Meltwater credentials. #### Example: Basic bXlfZW1haWxAZXhhbXJzZWNyZXQ=
clientId String Client ID

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json