Loading ...

REST API: URL Mapping API | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: URL Mapping API
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: URL Mapping API

0 
 /5
0 (0votes)

Using Axero's URL Mapping API, you can create and automate multiple URL redirects.

GET URL Mapping

Used to get URL mapper information. Valid for Communifire version 8 and above.

GET/api/urlmapper/

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
URLID String in the request body ID of URL Mapper entry you want to get.

Example URL to GET: 

https://your-community.com/api/urlmapper?urlID=55

Example Response

{

    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": 
   {
        "UrlID": 55,
        "OldUrl": "https://your-community.com/spaces/291/training-and-development/video/admin/instructional/9457/05-top-level-community-and-spaces",
        "NewUrl": "https://your-community.com/spaces/291/training-and-development/videos/admin/instructional/9457/05-top-level-community-and-spaces",
        "RedirectTypeID": 1,
        "IsActive": true,
        "DateAdded": "2022-09-21T20:34:39.8",
        "TenantID": 1

    }

}

 

Please Note Your content type that you pass in the header of your request should be 'application/json'.

 

Add URL Mapping

POST /api/urlmapper/

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
fromURL String in the request body the URL you want to redirect from
toURL String in the request body the URL you want to redirect to

Example URL to POST: 

https://your-community.com/api/urlmapper?fromURL=https://your-community.com/people/20164&toURL=https://your-community.com/spaces/11165

Delete URL Mapping

DELETE /api/urlmapper/multiple

Method Details

HTTP Method
DELETE
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
toURL String in the request body the URL you want to redirect to
Optional Parameters How to use Description
fromURL String in the request body the URL you want to redirect from

For DELETE, if using the "toURL" then the API will delete all mappings that point to that URL.

Example URL to DELETE: 

https://your-community.com/api/urlmapper?toURL=https://your-community.com/spaces/11165

Please Note Your content type that you pass in the header of your request should be 'application/json'.

See also: URL Mapper

Wiki Index

Pages

Intranet Software