com.mailosaur.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mailosaur-java Show documentation
Mailosaur Java Bindings for Email Test Automation
There is a newer version: 8.1.0
/**
 * This package contains the classes for MailosaurClient.
 * # Introduction
 This is an overview of the Mailosaur API. This API a RESTful JSON interface
 with predictable, resource-oriented URLs. We make use of HTTP response codes to indicate
 API errors.
 We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood
 by off-the-shelf HTTP clients.
 [Official client libraries](#) available for most popular languages.
 # Authentication
 Authenticate your account when using the API by including your API key in the request.
 You can manage your API keys in the Mailosaur UI. Your API key carrys many privileges,
 so be sure to keep it secret! Do not share your API key in publicly-accessible areas such
 GitHub, client-side code, and so on.
 All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
 API requests without authentication will also fail.
 # Errors
 ## HTTP status codes
 Mailosaur uses conventional HTTP response codes to indicate the success or failure of an
 API request. In general, codes in the `2xx` range indicate success, codes in the `4xx` range
 indicate an error that failed given the information provided (e.g., a required parameter
 was omitted), and codes in the `5xx` range indicate an error with
 Mailosaur's servers (give us a shout in the unlikely event that you see one of those).
 | Code | Description |
 |---|---|
 | 200 - OK | Request was successful. |
 | 204 - No Content | Request was successful, no response content. |
 | 400 - Bad Request | The request could be handled, often due to missing a required parameter. |
 | 401 - Unauthorized | No valid API key provided. |
 | 404 - Not Found | The requested resource doesn't exist. |
 | 5XX - Server Errors | Something went wrong at Mailosaur. (Give us a shout). |
 ## Error handling
 In of an error the server will return as much information as possible. In the case of a `401` or
 `404` error the status code gives as much information as you'd need. But for `400` errors
 Mailosaur will return a JSON object containing the structure below.
 Note that our client libraries convert responses to appropriate language-specific objects.
 | Property | Description |
 |---|---|
 | `type` | The type of error returned. Can be: api_connection_error, w, authentication_error, card_error, idempotency_error invalid_request_error, or rate_limit_error. |
 | `message` | A human-readable message providing more details about the error. |
 | `parameters` | A JSON object containing a key for each property name at fault, with a human-readable message per field |
 | `model` | The request model that we sent and failed to be processed |.
 */
package com.mailosaur;