File "api.twig"

Full Path: /home/cananyalcin/public_html/core/temp/client/sfg/api.twig
File size: 7.51 KB
MIME-type: text/html
Charset: utf-8

{% include 'header.twig' %}

  <div class="container pt-5 mb-5">
   
        <div class="row">
          <div class="col-lg-12">
            <div class="panel-form">
              
					  
                                 <div class="table-responsive">
                                    <div class="center-big-content-block">
          <h2 class="m-b-md">API Docs</h2>
		  
          <table class="table table-bordered">
            <tbody>
            <tr>
              <td class="width-40">HTTP Method</td>
              <td>POST</td>
            </tr>
            <tr>
              <td>API URL</td>
              <td>{{ site["url"] }}/api/v2</td>
            </tr>
            {% if user['auth'] %}
            <tr>
              <td>API Key</td>
              <td>{{ user["apikey"] }}</td>
            </tr>
            {% endif %}                        
            <tr>
              <td>Response format</td>
              <td>JSON</td>
            </tr>
            </tbody>
          </table>

                      <h4 class="m-t-md"><strong>Service list</strong></h4>
                          <table class="table table-bordered">
                <thead>
                <tr>
                  <th class="width-40">Parameters</th>
                  <th>Description</th>
                </tr>
                </thead>
                <tbody>
                  <tr>
                    <td>key</td>
                    <td>Your API key</td>
                  </tr>
                  <tr>
                    <td>action</td>
                    <td>services</td>
                  </tr>
                                </tbody>
              </table>
            
            <p><strong>Example response</strong></p>
<pre class="code">
[
    {
        "service": 1,
        "name": "Followers",
        "type": "Default",
        "category": "First Category",
        "rate": "0.90",
        "min": "50",
        "max": "10000"
    },
    {
        "service": 2,
        "name": "Comments",
        "type": "Custom Comments",
        "category": "Second Category",
        "rate": "8",
        "min": "10",
        "max": "1500"
    }
]
</pre>
                      <h4 class="m-t-md"><strong>Add order</strong></h4>
                                          <p>
                <form class="form-inline">
                  <div class="form-group">
                    <select class="form-control input-sm" id="service_type">
                                                  <option value="0">Default</option>
                                            </select>
                  </div>
                </form>
                </p>
                  <table class="table table-bordered">
                    <thead>
                    <tr>
                      <th class="width-40">Parameters</th>
                      <th>Description</th>
                    </tr>
                    </thead>
                    <tbody>
                                          <tr>
                        <td>key</td>
                        <td>Your API key</td>
                      </tr>
                                          <tr>
                        <td>action</td>
                        <td>add</td>
                      </tr>
                                          <tr>
                        <td>service</td>
                        <td>Service ID</td>
                      </tr>
                                          <tr>
                        <td>link</td>
                        <td>Link to page</td>
                      </tr>
                                          <tr>
                        <td>quantity</td>
                        <td>Needed quantity</td>
                      </tr>
                                          <tr>
                        <td>runs (optional)</td>
                        <td>Runs to deliver</td>
                      </tr>
                                          <tr>
                        <td>interval (optional)</td>
                        <td>Interval in minutes</td>
                      </tr>
                                        </tbody>
                  </table>
                          
            <p><strong>Example response</strong></p>
<pre class="code">
{
    "order": 23501
}
</pre>
                      <h4 class="m-t-md"><strong>Order status</strong></h4>
                          <table class="table table-bordered">
                <thead>
                <tr>
                  <th class="width-40">Parameters</th>
                  <th>Description</th>
                </tr>
                </thead>
                <tbody>
                                  <tr>
                    <td>key</td>
                    <td>Your API key</td>
                  </tr>
                                  <tr>
                    <td>action</td>
                    <td>status</td>
                  </tr>
                                  <tr>
                    <td>order</td>
                    <td>Order ID</td>
                  </tr>
                                </tbody>
              </table>
            
            <p><strong>Example response</strong></p>
<pre class="code">
{
    "charge": "0.27819",
    "start_count": "3572",
    "status": "Partial",
    "remains": "157",
    "currency": "USD"
}
</pre>
                      <h4 class="m-t-md"><strong>Multiple orders status</strong></h4>
                          <table class="table table-bordered">
                <thead>
                <tr>
                  <th class="width-40">Parameters</th>
                  <th>Description</th>
                </tr>
                </thead>
                <tbody>
                                  <tr>
                    <td>key</td>
                    <td>Your API key</td>
                  </tr>
                                  <tr>
                    <td>action</td>
                    <td>status</td>
                  </tr>
                                  <tr>
                    <td>orders</td>
                    <td>Order IDs separated by comma</td>
                  </tr>
                                </tbody>
              </table>
            
            <p><strong>Example response</strong></p>
<pre class="code">
{
    "1": {
        "charge": "0.27819",
        "start_count": "3572",
        "status": "Partial",
        "remains": "157",
        "currency": "USD"
    },
    "10": {
        "error": "Incorrect order ID"
    },
    "100": {
        "charge": "1.44219",
        "start_count": "234",
        "status": "In progress",
        "remains": "10",
        "currency": "USD"
    }
}
</pre>
                      <h4 class="m-t-md"><strong>User balance</strong></h4>
                          <table class="table table-bordered">
                <thead>
                <tr>
                  <th class="width-40">Parameters</th>
                  <th>Description</th>
                </tr>
                </thead>
                <tbody>
                                  <tr>
                    <td>key</td>
                    <td>Your API key</td>
                  </tr>
                                  <tr>
                    <td>action</td>
                    <td>balance</td>
                  </tr>
                                </tbody>
              </table>
            
            <p><strong>Example response</strong></p>
<pre class="code">
{
    "balance": "100.84292",
    "currency": "USD"
}
</pre>
                    <a href="/example.txt" class="btn btn-secondary m-t" target="_blank">Example of PHP code</a>
        </div>
      </div>
    </div>
  </div>
</div></div>
{% include 'footer.twig' %}