Add a logo

POST /api/1/logo

1	POST /api/1/logo

Add a logo image file or URL to your account.

Parameters

Name	Parameter Type	Allow Multiple	Required/ Optional	Data Type	Description
Authorization:	Header	False	Required	String (Bearer {access token})	Pass the authentication token that was granted when you authorized access
name	Form	False	Required	String	Display name of the logo in the UI.
alttext	Form	False	Optional	String	Alternative text for text-only views.
tooltip	Form	False	Optional	String	Tooltip text displayed when hovering over the image.
targeturl	Form	False	Optional	String	Target URL for the logo.
file	Body	False	Required if no imagelink parameter*	File	The logo image file.
imagelink	Form	False	Required if no file parameter*	String	The URL of the logo image.

*NOTE: Use file OR imagelink, not both.

Request

HTTP

Following is an example HTTP request:

POST /api/1/logo HTTP/1.1
Host: restapi.actonsoftware.com
Authorization: Bearer 6db77ed484add78154fe93bf9eb153fd
Cache-Control: no-cache
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="logo-1.jpg"
Content-Type: image/jpeg

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="name"

test-logo
----WebKitFormBoundary7MA4YWxkTrZu0gW

POST /api/1/logo HTTP/1.1

Host: restapi.actonsoftware.com

Authorization: Bearer 6db77ed484add78154fe93bf9eb153fd

Cache-Control: no-cache

Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW

Content-Disposition: form-data; name="file"; filename="logo-1.jpg"

Content-Type: image/jpeg

----WebKitFormBoundary7MA4YWxkTrZu0gW

Content-Disposition: form-data; name="name"

test-logo

----WebKitFormBoundary7MA4YWxkTrZu0gW

curl

Following is an example curl request:

curl -X POST -H "Authorization: Bearer 6db77ed484add78154fe93bf9eb153fd" -H "Cache-Control: no-cache" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "file=shutterstock_114970861.jpg" -F "name=test-logo" https://restapi.actonsoftware.com/api/1/logo

1	curl -X POST -H "Authorization: Bearer 6db77ed484add78154fe93bf9eb153fd" -H "Cache-Control: no-cache" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "file=shutterstock_114970861.jpg" -F "name=test-logo" https://restapi.actonsoftware.com/api/1/logo

Response

If the request succeeds, you’ll get an HTTP 200 response with a JSON object. Here’s the JSON response from the request made with JSON above:

{
    "status": "success",
    "message": "The logo has been uploaded",
    "id":   "i-4"
}

{

"status": "success",

"message": "The logo has been uploaded",

"id": "i-4"

}

Code Examples

The java code examples use the java unirest library available at unirest.io. You can also find unirest libraries for node, ruby, php, java, objective c, python, and .net.

Java

package content;

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.JsonNode;
import com.mashape.unirest.http.Unirest;
import com.mashape.unirest.http.exceptions.UnirestException;
import org.json.JSONObject;
import util.Utility;

import java.io.File;

public class PostLogoExample
{
    static String BASE_URL         = "https://restapi.actonsoftware.com/api/1/";
    public static void main(String[] args)
        {
                postLogoUsingFile();
                postLogoUsingImageUrl();
        }

    public static void postLogoUsingFile()
        {

        try
            {
            File file = new File("&lt;Provide Logo image&gt;");
            String accessToken  = Utility.getAccessToken();
            Unirest.setHttpClient(Utility.makeClient());
            Unirest.setDefaultHeader("Authorization", "Bearer " + accessToken);
            HttpResponse&lt;String&gt; jsonResponse = Unirest.post(BASE_URL + "logo")
                    .header("accept", "application/json")
                    .field("name", "testapipostlogo")
                    .field("alttext", "testapialttext")
                    .field("tooltip", "testapitooltip")
                    .field("targeturl", "https://www.google.com/")
                    .field("file", file)
                    .asString();

            if(jsonResponse.getCode()==200){
                String jsonResponseBody = jsonResponse.getBody();
                System.out.println("The response body is : "+jsonResponseBody );
            }else {
                System.out.println("The response is : "+ jsonResponse.toString());
            }
            }
        catch (UnirestException e)
            {
            e.printStackTrace();
            }
        }

    public static void postLogoUsingImageUrl()
        {

        try
            {
            String imagelink = "&lt;Provide image link url&gt;";
            String accessToken  = Utility.getAccessToken();
            Unirest.setHttpClient(Utility.makeClient());
            Unirest.setDefaultHeader("Authorization", "Bearer " + accessToken);
            HttpResponse&lt;String&gt; jsonResponse = Unirest.post(BASE_URL + "logo")
                    .header("accept", "application/json")
                    .field("name", "testapipostlogo2")
                    .field("imagelink", imagelink)
                    .field("alttext", "testapialttext2")
                    .field("tooltip", "testapitooltip2")
                    .field("targeturl", "https://www.google.com/")
                    .asString();

            if(jsonResponse.getCode()==200){
                String jsonResponseBody = jsonResponse.getBody();
                System.out.println("The response body is : "+jsonResponseBody );
            }else {
                System.out.println("The response is : "+ jsonResponse);
            }
            }
        catch (UnirestException e)
            {
            e.printStackTrace();
            }
        }

}

package content;

import com.mashape.unirest.http.HttpResponse;

import com.mashape.unirest.http.JsonNode;

import com.mashape.unirest.http.Unirest;

import com.mashape.unirest.http.exceptions.UnirestException;

import org.json.JSONObject;

import util.Utility;

import java.io.File;

public class PostLogoExample

{

static String BASE_URL = "https://restapi.actonsoftware.com/api/1/";

public static void main(String[] args)

{

postLogoUsingFile();

postLogoUsingImageUrl();

}

public static void postLogoUsingFile()

{

try

{

File file = new File("<Provide Logo image>");

String accessToken = Utility.getAccessToken();

Unirest.setHttpClient(Utility.makeClient());

Unirest.setDefaultHeader("Authorization", "Bearer " + accessToken);

HttpResponse<String> jsonResponse = Unirest.post(BASE_URL + "logo")

.header("accept", "application/json")

.field("name", "testapipostlogo")

.field("alttext", "testapialttext")

.field("tooltip", "testapitooltip")

.field("targeturl", "https://www.google.com/")

.field("file", file)

.asString();

if(jsonResponse.getCode()==200){

String jsonResponseBody = jsonResponse.getBody();

System.out.println("The response body is : "+jsonResponseBody );

}else {

System.out.println("The response is : "+ jsonResponse.toString());

}

catch (UnirestException e)

{

e.printStackTrace();

}

public static void postLogoUsingImageUrl()

{

try

{

String imagelink = "<Provide image link url>";

String accessToken = Utility.getAccessToken();

Unirest.setHttpClient(Utility.makeClient());

Unirest.setDefaultHeader("Authorization", "Bearer " + accessToken);

HttpResponse<String> jsonResponse = Unirest.post(BASE_URL + "logo")

.header("accept", "application/json")

.field("name", "testapipostlogo2")

.field("imagelink", imagelink)

.field("alttext", "testapialttext2")

.field("tooltip", "testapitooltip2")

.field("targeturl", "https://www.google.com/")

.asString();

if(jsonResponse.getCode()==200){

String jsonResponseBody = jsonResponse.getBody();

System.out.println("The response body is : "+jsonResponseBody );

}else {

System.out.println("The response is : "+ jsonResponse);

}

catch (UnirestException e)

{

e.printStackTrace();

}