mirror of
https://gitlab.linphone.org/BC/public/flexisip-account-manager.git
synced 2026-01-30 01:09:20 +00:00
603f1a6686
Complete the README documentation to add the artisan commands Add an API key authentication mechanism Update the dependencies
82 lines
2.7 KiB
PHP
82 lines
2.7 KiB
PHP
@extends('layouts.main')
|
|
|
|
@section('content')
|
|
<h1>Flexisip API</h1>
|
|
<p>An API to deal with the Flexisip server</p>
|
|
|
|
<p>The API is available under <code>/api</code></p>
|
|
<p>A <code>from</code> (consisting of the user SIP address, prefixed with <code>sip:</code>), <code>content-type</code> and <code>accept</code> HTTP headers are required to use the API properly</p>
|
|
|
|
<pre>
|
|
<code>> GET /api/{endpoint}
|
|
> from: sip:foobar@sip.example.org
|
|
> content-type: application/json
|
|
> accept: application/json</code></pre>
|
|
|
|
<h2>Authentication</h2>
|
|
|
|
<p>Restricted endpoints are protected using a DIGEST authentication or an API Key mechanisms.</p>
|
|
|
|
<h3>Using the API Key</h3>
|
|
|
|
<p>To authenticate using an API Key, you need to <a href="{{ route('account.login') }}">authenticate to your account panel</a> and being an administrator.</p>
|
|
<p>On your panel you will then find a form to generate your personnal key.</p>
|
|
|
|
<p>You can then use your freshly generated key by adding a new <code>x-api-key</code> header to your API requests:</p>
|
|
|
|
<pre>
|
|
<code>> GET /api/{endpoint}
|
|
> from: sip:foobar@sip.example.org
|
|
> x-api-key: {your-api-key}
|
|
> …</code></pre>
|
|
|
|
<h3>Using DIGEST</h3>
|
|
|
|
<p>To discover the available hashing algorythm you MUST send an unauthenticated request to one of the restricted endpoints.<br />
|
|
For the moment only DIGEST-MD5 and DIGEST-SHA-256 are supported through the authentication layer.</p>
|
|
|
|
<pre>
|
|
<code>> GET /api/{restricted-endpoint}
|
|
> …
|
|
|
|
< HTTP 401
|
|
< content-type: application/json
|
|
< www-authenticate: Digest realm=test,qop=auth,algorithm=MD5,nonce="{nonce}",opaque="{opaque}"
|
|
< www-authenticate: Digest realm=test,qop=auth,algorithm=SHA-256,nonce="{nonce}",opaque="{opaque}"</code></pre>
|
|
|
|
<p>You can find more documentation on the related <a href="https://tools.ietf.org/html/rfc7616">IETF RFC-7616</a>.</p>
|
|
|
|
<h2>Endpoints</h2>
|
|
|
|
<h3>Accounts</h3>
|
|
|
|
<h4><code>POST /accounts</code></h4>
|
|
|
|
<p>JSON parameters:</p>
|
|
|
|
<ul>
|
|
<li><code>username</code> unique username, minimum 6 characters</li>
|
|
<li><code>password</code> required minimum 6 characters</li>
|
|
<li><code>algorithm</code> required, values can be <code>SHA-256</code> or <code>MD5</code></li>
|
|
<li><code>domain</code> optional, the value is set to the default registration domain if not set</li>
|
|
<li><code>activated</code> optional, a boolean, set to <code>false</code> by default</li>
|
|
</ul>
|
|
|
|
<p>To create an account directly from the API.<br />This endpoint is authenticated and requires an admin account.</p>
|
|
|
|
<h3>Ping</h3>
|
|
|
|
<h4><code>GET /ping</code></h4>
|
|
|
|
<p>Returns <code>pong</code></p>
|
|
|
|
<h3>Devices</h3>
|
|
|
|
<h4><code>GET /devices</code></h4>
|
|
|
|
<p>Return the user registered devices.</p>
|
|
|
|
<h4><code>DELETE /devices/{uuid}</code></h4>
|
|
|
|
<p>Remove one of the user registered devices.</p>
|
|
@endsection
|