API access

<p class="graf graf--p">Chaskiq provides a Graphql API were you can query , create, update and delete campaings all the things that are provided in the admin inteface in which also consumes the same API. In order to consume and mutate Chaskiq data you&#x27;ll need to authenticate your requests via Oauth2.</p><p class="graf graf--p"></p><h2 class="graf graf--h3">Create application </h2><p class="graf graf--p">when you have logged into the Chaskiq panel , go to yourapp.com/oauth/applications and create a new application. If your application will be consumed by native application in which not requires redirection callback you can use the <b><i>urn:ietf:wg:oauth:2.0:oob </i></b>value for callback.</p><h2 class="graf graf--h3">Connect to application Example:</h2><p class="graf graf--p">This is a ruby example in which you can connect to the API. The xxx values expect the proper app_id &amp; secret generated on the oauth application you created in the previous step.</p><p>callback = &quot;urn:ietf:wg:oauth:2.0:oob&quot;<br/><br/>secret = &quot;xxxxx-api-secret&quot;<br/><br/>app_id = &quot;xxxx-app_id&quot;<br/><br/>client = OAuth2::Client.new(app_id, secret, site: &quot;https://app.chaskiq.io&quot;)<br/><br/>client.auth_code.authorize_url(redirect_uri: callback)<br/><br/></p><p class="graf graf--p">The last line will give you a url that you will need to visit in order to authorize the application.</p><p><br/> =&gt; &quot;https://app.chaskiq.io/oauth/authorize?client_id=xxx-app-id&amp;redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob&amp;response_type=code&quot;<br/><br/></p><p class="graf graf--p">and you will get something like this:</p><figure className="graf graf--figure">
                  <div>
                    <div className="aspectRatioPlaceholder is-locked" style="max-width: 1000px; max-height: 409px;">
                      <div className="aspect-ratio-fill" 
                          style="padding-bottom: 62.92307692307693%;">
                      </div>

                      <img src="/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--fa60af44e76c8526a6f1a244ebce53946990cb55/image.png" 
                        className="graf-image" 
                        contenteditable="false"
                      >
                    <div>
                  </div>

                  </div>
                  <figcaption className="imageCaption">
                    <span>
                      <span data-text="true">authorization step</span>
                    </span>
                  </figcaption>
                  </div>
                </figure><p class="graf graf--p">Once you&#x27;ve authorized the integration the platform will provide the code to make authorized requests to the API</p><p class="graf graf--p"></p><figure className="graf graf--figure">
                  <div>
                    <div className="aspectRatioPlaceholder is-locked" style="max-width: 1000px; max-height: 213px;">
                      <div className="aspect-ratio-fill" 
                          style="padding-bottom: 32.870370370370374%;">
                      </div>

                      <img src="/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--55b473474fa57be483b7dac3296a04580a7d1e32/image.png" 
                        className="graf-image" 
                        contenteditable="false"
                      >
                    <div>
                  </div>

                  </div>
                  <figcaption className="imageCaption">
                    <span>
                      <span data-text="true">auth code reponse</span>
                    </span>
                  </figcaption>
                  </div>
                </figure><p class="graf graf--p">The authorization code is the grant access that you can use to retrieve a new access_token. The following is a Ruby example with the Oauth2 gem to retrieve the access_token:</p><p class="graf graf--p"></p><p>require &#x27;oauth2&#x27;<br/><br/>client = OAuth2::Client.new(client_id, client_secret, :site =&gt; &#x27;http://localhost:3000&#x27;)<br/><br/>client.auth_code.authorize_url(:redirect_uri =&gt; &#x27;http://localhost:3000/callback&#x27;)<br/><br/>token = client.auth_code.get_token(authorization_code_value, :redirect_uri =&gt; &#x27;http://localhost:3000/callback&#x27;)</p>

Chaskiq provides a Graphql API were you can query , create, update and delete campaings all the things that are provided in the admin inteface in which also consumes the same API. In order to consume and mutate Chaskiq data you'll need to authenticate your requests via Oauth2.

when you have logged into the Chaskiq panel , go to yourapp.com/oauth/applications and create a new application. If your application will be consumed by native application in which not requires redirection callback you can use the urn:ietf:wg:oauth:2.0:oob value for callback.

This is a ruby example in which you can connect to the API. The xxx values expect the proper app_id & secret generated on the oauth application you created in the previous step.

callback = "urn:ietf:wg:oauth:2.0:oob"

secret = "xxxxx-api-secret"

app_id = "xxxx-app_id"

client = OAuth2::Client.new(app_id, secret, site: "https://app.chaskiq.io")

client.auth_code.authorize_url(redirect_uri: callback)



The last line will give you a url that you will need to visit in order to authorize the application.


 => "https://app.chaskiq.io/oauth/authorize?client_id=xxx-app-id&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob&response_type=code"



Once you've authorized the integration the platform will provide the code to make authorized requests to the API

The authorization code is the grant access that you can use to retrieve a new access_token. The following is a Ruby example with the Oauth2 gem to retrieve the access_token:

require 'oauth2'

client = OAuth2::Client.new(client_id, client_secret, :site => 'http://localhost:3000')

client.auth_code.authorize_url(:redirect_uri => 'http://localhost:3000/callback')

token = client.auth_code.get_token(authorization_code_value, :redirect_uri => 'http://localhost:3000/callback')