getDocumentation
Get API documentation
/docs
Usage and SDK Samples
curl -X GET \
-H "X-MAZEMAP-KEY-ID: [[apiKey]]" \
-H "X-MAZEMAP-API-KEY: [[apiKey]]" \
-H "Accept: text/html" \
"https://updates.mazemap.com/v1/docs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyId
ApiKeyAuth ApiKeyId = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyId");
ApiKeyId.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyId.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
// Create an instance of the API class
DefaultApi apiInstance = new DefaultApi();
try {
'String' result = apiInstance.getDocumentation();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getDocumentation");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
try {
final result = await api_instance.getDocumentation();
print(result);
} catch (e) {
print('Exception when calling DefaultApi->getDocumentation: $e\n');
}
import org.openapitools.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
try {
'String' result = apiInstance.getDocumentation();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getDocumentation");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-MAZEMAP-KEY-ID"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-MAZEMAP-KEY-ID"];
// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-MAZEMAP-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-MAZEMAP-API-KEY"];
// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Get API documentation
[apiInstance getDocumentationWithCompletionHandler:
^('String' output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var MazeMapUpdatesApiDraft = require('maze_map_updates_api__draft');
var defaultClient = MazeMapUpdatesApiDraft.ApiClient.instance;
// Configure API key authorization: ApiKeyId
var ApiKeyId = defaultClient.authentications['ApiKeyId'];
ApiKeyId.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyId.apiKeyPrefix['X-MAZEMAP-KEY-ID'] = "Token";
// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['X-MAZEMAP-API-KEY'] = "Token";
// Create an instance of the API class
var api = new MazeMapUpdatesApiDraft.DefaultApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getDocumentation(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class getDocumentationExample
{
public void main()
{
// Configure API key authorization: ApiKeyId
Configuration.Default.ApiKey.Add("X-MAZEMAP-KEY-ID", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("X-MAZEMAP-KEY-ID", "Bearer");
// Configure API key authorization: ApiKey
Configuration.Default.ApiKey.Add("X-MAZEMAP-API-KEY", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("X-MAZEMAP-API-KEY", "Bearer");
// Create an instance of the API class
var apiInstance = new DefaultApi();
try {
// Get API documentation
'String' result = apiInstance.getDocumentation();
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DefaultApi.getDocumentation: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyId
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-MAZEMAP-KEY-ID', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-MAZEMAP-KEY-ID', 'Bearer');
// Configure API key authorization: ApiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-MAZEMAP-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-MAZEMAP-API-KEY', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
try {
$result = $api_instance->getDocumentation();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getDocumentation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
# Configure API key authorization: ApiKeyId
$WWW::OPenAPIClient::Configuration::api_key->{'X-MAZEMAP-KEY-ID'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-MAZEMAP-KEY-ID'} = "Bearer";
# Configure API key authorization: ApiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-MAZEMAP-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-MAZEMAP-API-KEY'} = "Bearer";
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
eval {
my $result = $api_instance->getDocumentation();
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->getDocumentation: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyId
openapi_client.configuration.api_key['X-MAZEMAP-KEY-ID'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-MAZEMAP-KEY-ID'] = 'Bearer'
# Configure API key authorization: ApiKey
openapi_client.configuration.api_key['X-MAZEMAP-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-MAZEMAP-API-KEY'] = 'Bearer'
# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
try:
# Get API documentation
api_response = api_instance.get_documentation()
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->getDocumentation: %s\n" % e)
extern crate DefaultApi;
pub fn main() {
let mut context = DefaultApi::Context::default();
let result = client.getDocumentation(&context).wait();
println!("{:?}", result);
}