Base de Conhecimento

Main » EMBI Helpdesk » Ajuda e Treinamento » API » Adicionar Grupo
Adicionar Grupo

Exemplo de API:

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<?php
/**
 * This sample code is designed to connect to your Help Desk Software using the Unserialization method.
 */
 
 
// By default, this sample code is designed to get the result from your
// server (where Help Desk is installed) and to print out the result
$url    = 'http://yourdomain.com/path/to/hd';
 
 
$params = array(
 
    // the API Username and Password are the same as your login access to the Admin panel
    // replace these with your info
    'api_user'     => 'YOUR_USERNAME',
    'api_pass'     => 'YOUR_PASSWORD',
 
    // this is the action that adds a group
    'api_action'   => 'group_add',
 
    // define the type of output you wish to get back
    // possible values:
    // - 'xml'  :      you have to write your own XML parser
    // - 'json' :      data is returned in JSON format and can be decoded with
    //                 json_decode() function (included in PHP since 5.2.0)
    // - 'serialize' : data is returned in a serialized format and can be decoded with
    //                 a native unserialize() function
    'api_output'   => 'serialize',
);
 
// here we define the data we are posting in order to perform an update
$post = array(
    //'id'       => 0, // adds a new one
    'title' => 'Group Title',
    'descript' => 'Group Description',
 
    // assign it departments:
    'depts[]' => '1', // access to one department
    //'depts[]' => '2', // some more departments?
 
    // permissions (uncomment the ones you wish to add)
    // see the admin interface for explanation on what each of these pertain to
 
    // Help Desk permissions
    //'pg_department_add' => '1',
    //'pg_department_edit' => '1',
    //'pg_department_delete' => '1',
    //'pg_department_fields' => '1',
    //'pg_savedresponse_add' => '1',
    //'pg_ticket_add' => '1',
    //'pg_ticket_edit' => '1',
    //'pg_ticket_delete' => '1',
    //'pg_ticket_edit_details' => '1',
    //'pg_ticket_edit_spam' => '1',
    //'pg_ticket_edit_assign' => '1',
    //'pg_ticket_edit_unassign' => '1',
    //'pg_ticket_edit_merge' => '1',
    //'pg_ticket_edit_split' => '1',
    //'pg_ticket_edit_stick' => '1',
    //'pg_ticket_subscribe' => '1',
    //'pg_ticket_export' => '1',
    //'pg_view_add' => '1',
    //'pg_view_edit' => '1',
    //'pg_view_delete' => '1',
    //'pg_user_add' => '1',
    //'pg_user_edit' => '1',
    //'pg_user_delete' => '1',
    //'pg_user_public' => '1',
    //'pg_emailusers_send' => '1',
    //'pg_company_add' => '1',
    //'pg_company_edit' => '1',
    //'pg_company_delete' => '1',
    //'pg_troubleshooter_add' => '1',
    //'pg_troubleshooter_edit' => '1',
    //'pg_troubleshooter_delete' => '1',
    //'pg_filelibrary_add' => '1',
    //'pg_filelibrary_edit' => '1',
    //'pg_filelibrary_delete' => '1',
    //'pg_calendar_add' => '1',
    //'pg_calendar_edit' => '1',
    //'pg_calendar_delete' => '1',
    //'pg_task_add' => '1',
    //'pg_task_edit' => '1',
    //'pg_task_delete' => '1',
    //'pg_reports' => '1',
 
    // KB permissions
    'kb_p[]' => '1', // access to one KB category
    //'kb_p[]' => '2', // some more KB categories?
    //'pg_kb_article_add' => '1',
    //'pg_kb_article_edit' => '1',
    //'pg_kb_article_delete' => '1',
    //'pg_kb_article_approve' => '1',
    //'pg_kb_category_add' => '1',
    //'pg_kb_comment_add' => '1',
    //'pg_kb_term_add' => '1',
    //'pg_kb_index_add' => '1',
);
 
// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= $key . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');
 
// This section takes the input data and converts it to the proper format
$data = "";
foreach( $post as $key => $value ) $data .= $key . '=' . urlencode($value) . '&';
$data = rtrim($data, '& ');
 
// clean up the url
$url = rtrim($url, '/ ');
 
// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');
 
// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
    die('JSON not supported. (introduced in PHP 5.2.0)');
}
 
// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;
 
$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
curl_setopt($request, CURLOPT_POSTFIELDS, $data); // use HTTP POST to send form data
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
 
$response = (string)curl_exec($request); // execute curl post and store results in $response
 
// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object
 
if ( !$response ) {
    die('Nothing was returned. Do you have a connection to Email Marketing server?');
}
 
// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...
 
// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';
 
// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';
 
// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';
 
// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;
 
?>
Adicionar Comentários

0.00
Base de Conhecimento

Adicionar Grupo

Exemplo de API:

Adicionar Comentários

Artigos relacionados
