Arma Reforger:REST API Usage - Revision history

Lou Montana: Some wiki formatting

2025-09-03T14:39:18Z

Some wiki formatting

← Older revision		Revision as of 16:39, 3 September 2025
Line 49:		Line 49:
	override void OnError(int errorCode)		override void OnError(int errorCode)
	{		{
	~~Print~~("OnError()");		PrintFormat("OnError(%1)", errorCode);
	}		}

Line 61:		Line 61:
	override void OnSuccess(string data, int dataSize)		override void OnSuccess(string data, int dataSize)
	{		{
	~~Print~~("OnSuccess() - data size = " + dataSize ~~+ " bytes"~~);		PrintFormat("OnSuccess() - data size = %1 bytes", dataSize);
	if (dataSize > 0)		if (dataSize > 0)
	Print(data); // note that Print() will not output strings longer than 1024b to console, check the dataSize!		Print(data); // note that Print() will not output strings longer than 1024b to console, check the dataSize!
Line 69:		Line 69:
	class HttpElement		class HttpElement
	{		{
	protected ref RestCallbackExample ~~m_callbackExample~~;		protected ref RestCallbackExample m_CallbackExample;

	//------------------------------------------------------------------------------------------------		//------------------------------------------------------------------------------------------------
	void ExecuteRequest()		void ExecuteRequest()
	{		{
	if (!~~m_callbackExample~~)		if (!m_CallbackExample)
	~~m_callbackExample~~ = new RestCallbackExample();		m_CallbackExample = new RestCallbackExample();

	string contextURL = "https://httpbin.org/";		string contextURL = "https://httpbin.org/";
Line 82:		Line 82:
	// executed request is "get" in "https://httpbin.org/" context (i.e "https://httpbin.org/get")		// executed request is "get" in "https://httpbin.org/" context (i.e "https://httpbin.org/get")
	// using the HTTP's GET method		// using the HTTP's GET method
	context.GET(~~m_callbackExample~~, "get");		context.GET(m_CallbackExample, "get");

	// it is possible to assemble a more complex request using arguments, like this:		// it is possible to assemble a more complex request using arguments, like this:
	// ctx.GET(~~m_callbackExample~~, "get?x=10&y=5");		// ctx.GET(m_CallbackExample, "get?x=10&y=5");
	}		}
	}		}

Lou Montana: Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

2025-02-26T12:32:02Z

Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

← Older revision		Revision as of 14:32, 26 February 2025
Line 108:		Line 108:


	{{GameCategory\|armaR\|Modding\|Tutorials~~\|Scripting~~}}		{{GameCategory\|armaR\|Modding\|Scripting\|Tutorials}}

Lou Montana: Remove after class' semicolons

2023-05-19T10:23:18Z

Remove after class' semicolons

← Older revision		Revision as of 12:23, 19 May 2023
Line 35:		Line 35:
	class RestCallbackExample : RestCallback		class RestCallbackExample : RestCallback
	{		{
	};		}
	</enforce>		</enforce>

Line 50:		Line 50:
	{		{
	Print("OnError()");		Print("OnError()");
	};		}

	//------------------------------------------------------------------------------------------------		//------------------------------------------------------------------------------------------------
Line 56:		Line 56:
	{		{
	Print("OnTimeout()");		Print("OnTimeout()");
	};		}

	//------------------------------------------------------------------------------------------------		//------------------------------------------------------------------------------------------------
Line 64:		Line 64:
	if (dataSize > 0)		if (dataSize > 0)
	Print(data); // note that Print() will not output strings longer than 1024b to console, check the dataSize!		Print(data); // note that Print() will not output strings longer than 1024b to console, check the dataSize!
	};		}
	};		}

	class HttpElement		class HttpElement
Line 87:		Line 87:
	// ctx.GET(m_callbackExample, "get?x=10&y=5");		// ctx.GET(m_callbackExample, "get?x=10&y=5");
	}		}
	};		}
	</enforce>		</enforce>

Line 104:		Line 104:
	m_HttpElement.ExecuteRequest();		m_HttpElement.ExecuteRequest();
	}		}
	};		}
	</enforce>		</enforce>


	{{GameCategory\|armaR\|Modding\|Tutorials\|Scripting}}		{{GameCategory\|armaR\|Modding\|Tutorials\|Scripting}}

Lou Montana: Fix Wikipedia link

2023-02-23T23:02:36Z

Fix Wikipedia link

← Older revision		Revision as of 01:02, 24 February 2023
Line 7:		Line 7:

	{{Feature\|important\|		{{Feature\|important\|
	The REST API is only meant to provide basic REST functionality (GET and POST methods - see {{~~Wikipedia~~\|~~Hypertext Transfer Protocol~~#~~Request methods~~\|HTTP request methods}}), ''not'' full server functionality (like e.g {{Link\|https://curl.se/\|curl}}).		The REST API is only meant to provide basic REST functionality (GET and POST methods - see {{Link\|https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods\|HTTP request methods}}), ''not'' full server functionality (like e.g {{Link\|https://curl.se/\|curl}}).
	* Data size accepted by the API has to be '''below 1 MB'''		* Data size accepted by the API has to be '''below 1 MB'''
	* There is no support for custom headers		* There is no support for custom headers

Lou Montana: Fix Wikipedia link

2023-02-23T23:00:17Z

Fix Wikipedia link

← Older revision		Revision as of 01:00, 24 February 2023
Line 3:		Line 3:
	This page explains the terminology and how to use the scripting API.		This page explains the terminology and how to use the scripting API.

	{{Feature\|informative\|See also the {{~~Wikipedia~~\|~~Representational state transfer~~}} Wikipedia article.}}		{{Feature\|informative\|See also the {{Link\|https://en.wikipedia.org/wiki/Representational_state_transfer}} Wikipedia article.}}


Line 35:		Line 35:
	class RestCallbackExample : RestCallback		class RestCallbackExample : RestCallback
	{		{
	}		};
	</enforce>		</enforce>

Line 104:		Line 104:
	m_HttpElement.ExecuteRequest();		m_HttpElement.ExecuteRequest();
	}		}
	}		};
	</enforce>		</enforce>


	{{GameCategory\|armaR\|Modding\|Tutorials\|Scripting}}		{{GameCategory\|armaR\|Modding\|Tutorials\|Scripting}}

Lou Montana: Add curl link

2023-01-13T11:08:08Z

Add curl link

← Older revision		Revision as of 13:08, 13 January 2023
Line 7:		Line 7:

	{{Feature\|important\|		{{Feature\|important\|
	The REST API is only meant to provide basic REST functionality (GET and POST methods - see {{Wikipedia\|Hypertext Transfer Protocol#Request methods\|HTTP request methods}}), ''not'' full server functionality (like e.g curl).		The REST API is only meant to provide basic REST functionality (GET and POST methods - see {{Wikipedia\|Hypertext Transfer Protocol#Request methods\|HTTP request methods}}), ''not'' full server functionality (like e.g {{Link\|https://curl.se/\|curl}}).
	* Data size accepted by the API has to be '''below 1 MB'''		* Data size accepted by the API has to be '''below 1 MB'''
	* There is no support for custom headers		* There is no support for custom headers

Lou Montana: Fix data unit

2023-01-11T23:04:33Z

Fix data unit

← Older revision		Revision as of 01:04, 12 January 2023
Line 61:		Line 61:
	override void OnSuccess(string data, int dataSize)		override void OnSuccess(string data, int dataSize)
	{		{
	Print("OnSuccess() - data size = " + dataSize + " b");		Print("OnSuccess() - data size = " + dataSize + " bytes");
	if (dataSize > 0)		if (dataSize > 0)
	Print(data); // note that Print() will not output strings longer than 1024b to console, check the dataSize!		Print(data); // note that Print() will not output strings longer than 1024b to console, check the dataSize!

Lou Montana: Page creation

2023-01-11T15:06:25Z

Page creation

New page

{{TOC|side}}
The '''REST API''' ({{Link/Enfusion|armaR|RestApi}}) is a simplified way to call REST requests and handle results/data, allowing to communicate with a web API.
This page explains the terminology and how to use the scripting API.

{{Feature|informative|See also the {{Wikipedia|Representational state transfer}} Wikipedia article.}}

{{Feature|important|
The REST API is only meant to provide basic REST functionality (GET and POST methods - see {{Wikipedia|Hypertext Transfer Protocol#Request methods|HTTP request methods}}), ''not'' full server functionality (like e.g curl).
* Data size accepted by the API has to be '''below 1 MB'''
* There is no support for custom headers
* There is limited printout
}}

== Definitions ==

=== Context ===

The '''context''' is simply the website URL with which transactions will happen, e.g https://httpbin.org/.

A {{Link/Enfusion|armaR|RestContext}} context can be created with the following:
<enforce>
RestContext ctx = GetGame().GetRestApi().GetContext("https://httpbin.org/");
</enforce>

=== Callback ===

A '''callback''' is a script class handling a request's success, error or timeout.

Once the request happens (asynchronously) the callback methods are called to process the received result.

The scripter is responsible for the callback object's lifetime. Inherit from {{Link/Enfusion|armaR|RestCallback}} and implement the desired methods to create a custom callback:
<enforce>
class RestCallbackExample : RestCallback
{
}
</enforce>

== Example ==

=== Declaration ===

<enforce>
class RestCallbackExample : RestCallback
{
//------------------------------------------------------------------------------------------------
override void OnError(int errorCode)
{
Print("OnError()");
};

//------------------------------------------------------------------------------------------------
override void OnTimeout()
{
Print("OnTimeout()");
};

//------------------------------------------------------------------------------------------------
override void OnSuccess(string data, int dataSize)
{
Print("OnSuccess() - data size = " + dataSize + " b");
if (dataSize > 0)
Print(data); // note that Print() will not output strings longer than 1024b to console, check the dataSize!
};
};

class HttpElement
{
protected ref RestCallbackExample m_callbackExample;

//------------------------------------------------------------------------------------------------
void ExecuteRequest()
{
if (!m_callbackExample)
m_callbackExample = new RestCallbackExample();

string contextURL = "https://httpbin.org/";
RestContext context = GetGame().GetRestApi().GetContext(contextURL);

// executed request is "get" in "https://httpbin.org/" context (i.e "https://httpbin.org/get")
// using the HTTP's GET method
context.GET(m_callbackExample, "get");

// it is possible to assemble a more complex request using arguments, like this:
// ctx.GET(m_callbackExample, "get?x=10&y=5");
}
};
</enforce>

=== Call ===

<enforce>
class HolderClass
{
protected ref HttpElement m_HttpElement;

void PerformGETRequest()
{
if (!m_HttpElement)
m_HttpElement = new HttpElement();

m_HttpElement.ExecuteRequest();
}
}
</enforce>

{{GameCategory|armaR|Modding|Tutorials|Scripting}}